API REST

Când doriți să afișați răspunsurile pe propriul site web sau să le preluați periodic în sistemul dvs., utilizați API-ul REST. Returnează date în format JSON, se autentifică cu o cheie API și acceptă aceleași filtre pe care le cunoașteți din tabelul de rezultate.

De reținut: editorul Gatherino și contul sunt disponibile în engleză sau cehă. Formularele completate de respondenți pot fi afișate în 18 limbi, inclusiv în română.

Ce poate face API-ul

  • Listați formularele dintr-un spațiu de lucru și obțineți un formular individual, inclusiv structura acestuia.
  • Listați răspunsurile cu filtre: după formular, stare, interval de date, text complet și sortare.
  • Obțineți un singur răspuns.
  • Actualizați starea unui răspuns.
  • Trimiteți un formular programatic – util pentru migrări sau pentru o interfață front-end personalizată.

Preluarea răspunsurilor

Autentificarea se face prin antetul Authorization (funcționează și un antet 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 }

Primii pași

  1. 1

    Creați o cheie API

    În Setări → Chei API. Cheia se afișează o singură dată, așa că salvați-o imediat.

  2. 2

    Efectuați primul apel

    Încercați să listați formularele pentru a confirma că cheia funcționează și pentru a obține ID-ul formularului.

  3. 3

    Asociați ID-urile câmpurilor cu etichetele

    Detaliile formularului returnează ID-ul și eticheta fiecărui câmp – creați un dicționar pe baza acestora. ID-urile câmpurilor sunt stabile, deci este suficient să le preluați o singură dată.

  4. 4

    Gestionarea paginării

    Numărul maxim este de 100 de răspunsuri pe cerere. Pentru mai multe date, parcurgeți paginile până ajungeți la ultima pagină.

Cheia API trebuie păstrată pe serverul dvs., niciodată în JavaScript-ul din browser – oricine ar putea-o citi acolo și descărca toate răspunsurile. Dacă publicați răspunsuri, expuneți doar câmpurile destinate publicării, niciodată date personale.

Întrebări frecvente

Cum se autentifică API-ul?

Cu o cheie API: fie un antet Authorization: Bearer <key>, fie un antet x-api-key. O cheie invalidă returnează eroarea 401.

Câte răspunsuri se returnează pe cerere?

Până la 100. Răspunsul include total și totalPages, pentru a putea parcurge paginile următoare.

De ce cheile datelor arată precum field_1778…?

Acestea sunt ID-urile câmpurilor formularului. Preluați etichetele lor din detaliile formularului și păstrați maparea de pe partea dvs.

API-ul acceptă diacritice?

Da, totul este în UTF-8, deci textele în cehă și în alte limbi funcționează fără probleme.

Similare

Încearcă Gatherino gratuit

Plan gratuit: 3 formulare și 100 de răspunsuri pe lună. Fără card de credit, date găzduite în UE.

Începe gratuit →