REST API

Ha a válaszokat a saját weboldalán szeretné megjeleníteni, vagy ütemezetten a saját rendszerébe szeretné átemelni, használja a REST API-t. JSON formátumot ad vissza, API-kulccsal hitelesít, és ugyanazokat a szűrőket támogatja, amelyeket az eredménytáblázatból ismer.

Jó tudni: a Gatherino szerkesztője és fiókja angol vagy cseh nyelven érhető el. A kitöltők által látott űrlapok 18 nyelven jeleníthetők meg, ideértve a magyart is.

Mire képes az API

  • Egy munkaterület űrlapjainak listázása, illetve egy adott űrlap lekérése a szerkezetével együtt.
  • Beküldések listázása szűrőkkel: űrlap, állapot, dátumtartomány és teljes szöveges keresés szerint, rendezési lehetőséggel.
  • Egyetlen beküldés lekérése.
  • Beküldés állapotának frissítése.
  • Űrlap programozott beküldése – hasznos migrálásnál vagy egyedi felületnél.

Beküldések lekérése

Hitelesítés az Authorization fejléccel (az x-api-key fejléc is működik):

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 }

Első lépések

  1. 1

    API-kulcs létrehozása

    A Beállítások → API-kulcsok menüpontban. A kulcs csak egyszer jelenik meg, ezért azonnal mentse el.

  2. 2

    Első hívás elindítása

    Próbálja ki az űrlapok listázását, hogy ellenőrizze a kulcs működését, és megkapja az űrlap azonosítóját.

  3. 3

    Mezőazonosítók megfeleltetése címkékkel

    Az űrlap részletei minden mező azonosítóját és címkéjét visszaadják – ebből építsen keresőtáblát. A mezőazonosítók állandóak, ezért elég egyszer lekérni őket.

  4. 4

    Lapozás kezelése

    Egy kérésben legfeljebb 100 beküldés kérhető le. További adatokért lapozzon végig az oldalakon az utolsóig.

Az API-kulcsot a szerverén kell tárolnia, soha nem a böngészőben futó JavaScriptben – ott bárki kiolvashatja, és letöltheti az összes válaszát. Ha közzéteszi a válaszokat, csak a közzétételre szánt mezőket tegye elérhetővé, soha a személyes adatokat.

GYIK

Hogyan hitelesít az API?

API-kulccsal: vagy egy Authorization: Bearer <kulcs> fejléccel, vagy egy x-api-key fejléccel. Érvénytelen kulcs esetén 401-es választ kap.

Hány beküldés kérhető egy kéréssel?

Legfeljebb 100. A válasz tartalmazza a total és a totalPages mezőket, így további oldalakon is végiglapozhat.

Miért olyanok az adatkulcsok, mint a field_1778…?

Ezek az űrlap mezőazonosítói. Címkéiket az űrlap részleteiből kérheti le, a megfeleltetést pedig a saját oldalán tárolja.

Kezeli az API az ékezeteket?

Igen, minden UTF-8 kódolású, így a cseh és más nyelvek ékezetei problémamentesen működnek.

Kapcsolódó

Próbálja ki a Gatherinót ingyen

Ingyenes csomag: havi 3 űrlap és 100 válasz. Bankkártya nem szükséges, az adatok EU-ban tárolódnak.

Kezdje el ingyen →