API FlowForm нужен, чтобы забирать ответы и статистику в ваши сервисы (CRM, аналитика, внутренние инструменты) и управлять доступом через API-ключи.
Схема «FlowForm → API → CRM/аналитика»
Базовые принципы
- все запросы идут в версию `/v1`
- доступ к API выполняется по API-ключу
- минимальный набор включает только ключи, чтение форм, ответы и статистику
Минимальныи гарантированный набор эндпоинтов
Ниже — то, что можно смело фиксировать в документации как “точно работает”.
### API-ключи Используются для выдачи и управления доступом к API:
- POST `/v1/api-keys` — создать API-ключ
- GET `/v1/api-keys` — список ключей
- DELETE `/v1/api-keys/:id` — удалить ключ
Блок «API ключи и доступы» в личном кабинете
### Формы (метаданные) Эти ручки возвращают только метаданные формы (например, id, название, статус):
- GET `/v1/forms` — список форм
- GET `/v1/forms/:id` — получить форму по id
### Ответы Чтобы забирать результаты прохождения формы:
- GET `/v1/forms/:id/responses` — список ответов по форме
- GET `/v1/forms/:id/responses/:responseId` — один ответ по id
- GET `/v1/forms/:id/responses/export?format=csv` — экспорт ответов в CSV
### Статистика Для сводных показателей:
- GET `/v1/forms/:id/stats` — статистика конкретной формы
- GET `/v1/forms/stats` — сводная статистика по формам
Дальше по теме
Далее логично разобрать, как создавать и удалять API-ключи, чтобы безопасно выдавать доступ интеграциям и при необходимости быстро его отзывать.