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 документацияWebhooksУправление на отговоритеDiscordGoogle Sheets

Опитайте Gatherino безплатно

Безплатен план: 3 формуляра и 100 отговора месечно. Без кредитна карта, данните се съхраняват в ЕС.

Започнете безплатно →