REST API для форм

Якщо ви хочете показувати відповіді на своєму сайті або за розкладом передавати їх у свою систему, використовуйте REST API. Він повертає JSON, автентифікується за API-ключем і підтримує ті самі фільтри, що й таблиця результатів.

Почніть безкоштовно →Ціни

Варто знати: редактор і обліковий запис Gatherino доступні англійською або чеською мовами. Форми, які заповнюють ваші респонденти, можна показувати 18 мовами, зокрема українською.

Що вміє API

  • Отримувати список форм у робочому просторі та одну форму разом з її структурою.
  • Отримувати список відповідей із фільтрами: за формою, статусом, діапазоном дат, повнотекстовим пошуком, а також сортування.
  • Отримувати одну відповідь.
  • Оновлювати статус відповіді.
  • Надсилати форму програмно, що зручно для міграцій або власного інтерфейсу.

Отримання відповідей

Автентифікація через заголовок Authorization (працює й заголовок x-api-key):

curl "https://gatherino.com/api/v1/submissions?formId=FORM_ID&limit=50" \
  -H "Authorization: Bearer gk_your_key"

# response
{ "items": [ { "id": "…", "status": "NEW", "createdAt": "…",
               "data": { "field_1778…": "Jan Vondráček" } } ],
  "total": 672, "page": 1, "limit": 50, "totalPages": 14 }

Початок роботи

  1. 1

    Створіть API-ключ

    Перейдіть до Налаштування → API-ключі. Ключ показується лише один раз, тож одразу збережіть його.

  2. 2

    Зробіть перший запит

    Спробуйте отримати список форм, щоб перевірити, що ключ працює, і дізнатися ID форми.

  3. 3

    Зіставте ID полів із мітками

    Деталі форми повертають ID та мітку кожного поля. На їх основі створіть словник відповідності. ID полів не змінюються, тому достатньо отримати їх один раз.

  4. 4

    Пагінація

    Максимум становить 100 відповідей на запит. Щоб отримати більше даних, переходьте по сторінках, доки не дійдете до останньої.

API-ключ має зберігатися на вашому сервері, а не в JavaScript у браузері. Там його може прочитати будь-хто й завантажити всі ваші відповіді. Якщо ви публікуєте відповіді, відкривайте лише поля, призначені для публікації, і ніколи не показуйте персональні дані.

Часті питання

Як відбувається автентифікація в API?

За допомогою API-ключа: через заголовок Authorization: Bearer <key> або заголовок x-api-key. Недійсний ключ повертає помилку 401.

Скільки відповідей можна отримати за один запит?

До 100. Відповідь містить total і totalPages, щоб ви могли переходити до наступних сторінок.

Чому ключі даних виглядають як field_1778…?

Це ID полів форми. Отримайте їхні мітки з деталей форми та зберігайте відповідність на своєму боці.

Чи підтримує API діакритичні знаки?

Так, усі дані передаються у UTF-8, тож чеська та інші мови працюють без проблем.

Схожі матеріали

Документація APIВебхукиКерування відповідямиDiscordGoogle Sheets

Спробуйте Gatherino безкоштовно

Безкоштовний тариф: 3 форми та 100 відповідей на місяць. Банківська картка не потрібна, дані зберігаються в ЄС.

Почніть безкоштовно →