REST API

Když potřebujete odpovědi zobrazit na vlastním webu nebo je pravidelně stahovat do svého systému, použijete REST API. Vrací JSON, autorizuje se API klíčem a umí stejné filtry, jaké znáte z tabulky odpovědí.

Začít zdarma →Ceník

Co API umí

  • Seznam formulářů ve workspacu a detail konkrétního formuláře včetně jeho struktury.
  • Seznam odpovědí s filtry: podle formuláře, stavu, období, fulltextu i s řazením.
  • Detail jedné odpovědi.
  • Změnu stavu odpovědi.
  • Programové odeslání formuláře — hodí se pro migrace nebo vlastní frontend.

Načtení odpovědí

Autorizace hlavičkou Authorization (funguje i hlavička x-api-key):

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

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

Jak začít

  1. 1

    Vytvořte API klíč

    V Nastavení → API klíče. Klíč se zobrazí jen jednou, hned si ho uložte.

  2. 2

    Zavolejte první požadavek

    Vyzkoušejte seznam formulářů, abyste ověřili, že klíč funguje a získali ID formuláře.

  3. 3

    Přeložte si ID polí na názvy

    V detailu formuláře najdete u každého pole jeho ID i popisek — z toho si postavíte převodní tabulku. ID polí se nemění, stačí načíst jednou.

  4. 4

    Ošetřete stránkování

    Maximum je 100 odpovědí na požadavek. Pro víc dat procházejte stránky, dokud nedojdete na poslední.

API klíč patří na server, nikdy do JavaScriptu ve stránce — v prohlížeči si ho může kdokoli přečíst a stáhnout všechny vaše odpovědi. Pokud odpovědi zveřejňujete, publikujte jen pole, která k tomu jsou určená, ne osobní údaje.

Časté otázky

Jak se API autorizuje?

API klíčem: buď hlavičkou Authorization: Bearer <klíč>, nebo hlavičkou x-api-key. Neplatný klíč vrací 401.

Kolik odpovědí vrátí jeden požadavek?

Nejvýš 100. Odpověď obsahuje total a totalPages, podle kterých procházíte další stránky.

Proč jsou v datech klíče jako field_1778…?

To jsou ID polí formuláře. Popisky k nim získáte z detailu formuláře — mapování si uložte u sebe.

Zvládá API diakritiku?

Ano, data chodí v UTF-8, čeština i další jazyky bez problémů.

Souvisí s tímto

Dokumentace APIWebhookySpráva odpovědí

Vyzkoušejte Gatherino zdarma

Free plán: 3 formuláře a 100 odpovědí měsíčně. Bez kreditky, data v EU.

Začít zdarma →