REST API

Če želite odgovore prikazati na svoji spletni strani ali jih redno prenašati v svoj sistem po urniku, uporabite REST API. Vrača podatke v formatu JSON, dostop se overi z API ključem, podpira pa iste filtre, ki jih poznate iz tabele z odgovori.

Začnite brezplačno →Cene

Dobro je vedeti: urejevalnik in račun Gatherino sta v angleščini ali češčini. Obrazci, ki jih izpolnjujejo vaši izpolnjevalci, so lahko prikazani v 18 jezikih, vključno s slovenščino.

Kaj lahko počne API

  • Izpišite obrazce v delovnem prostoru in pridobite posamezen obrazec z njegovo strukturo.
  • Izpišite odgovore s filtri: po obrazcu, statusu, datumskem obdobju, celotnem besedilu ter z razvrščanjem.
  • Pridobite posamezen odgovor.
  • Posodobite status odgovora.
  • Oddajte obrazec programsko – uporabno za migracije podatkov ali lasten uporabniški vmesnik.

Pridobivanje odgovorov

Overitev poteka z glavo Authorization (deluje tudi glava 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 }

Prvi koraki

  1. 1

    Ustvarite API ključ

    Najdete ga v razdelku Nastavitve → API ključi. Ključ je prikazan samo enkrat, zato ga takoj shranite.

  2. 2

    Opravite prvi klic

    Poskusite izpisati obrazce, da preverite, ali ključ deluje, in pridobite ID obrazca.

  3. 3

    Povežite ID-je polj z oznakami

    Podrobnosti obrazca vrnejo ID in oznako vsakega polja – iz njih zgradite preslikavo. ID-ji polj so stabilni, zato je dovolj, da jih pridobite enkrat.

  4. 4

    Delo s paginacijo

    Največ je 100 odgovorov na zahtevo. Za več podatkov listajte po straneh, dokler ne pridete do zadnje.

API ključ mora biti shranjen na vašem strežniku, nikoli v JavaScriptu v brskalniku – kdorkoli bi ga tam lahko prebral in prenesel vse vaše odgovore. Če objavljate odgovore, izpostavite le polja, namenjena objavi, nikoli osebnih podatkov.

Pogosta vprašanja

Kako API overi zahtevke?

Z API ključem: bodisi z glavo Authorization: Bearer <ključ> bodisi z glavo x-api-key. Neveljaven ključ vrne napako 401.

Koliko odgovorov je na zahtevo?

Največ 100. Odgovor vsebuje polji total in totalPages, da se lahko pomikate po straneh.

Zakaj so ključi podatkov oblike field_1778…?

To so ID-ji polj obrazca. Njihove oznake pridobite iz podrobnosti obrazca in preslikavo hranite na svoji strani.

Ali API podpira posebne znake (šumnike)?

Da, vse je kodirano v UTF-8, zato češčina in drugi jeziki delujejo brez težav.

Sorodno

API dokumentacijaWebhookiUpravljanje odgovorovDiscordGoogle Sheets

Preizkusite Gatherino brezplačno

Brezplačni paket: 3 obrazci in 100 odgovorov na mesec. Brez kreditne kartice, podatki so gostovani v EU.

Začnite brezplačno →