REST API

Wil je antwoorden op je eigen website tonen of op vaste momenten in je systeem laden? Dan gebruik je de REST API. Die geeft JSON terug, authenticeert met een API-sleutel en ondersteunt dezelfde filters die je kent van de resultatentabel.

Goed om te weten: de Gatherino-editor en je account zijn in het Engels of Tsjechisch. De formulieren die je invullers invullen, kunnen in 18 talen worden getoond, inclusief het Nederlands.

Wat de API kan

  • Formulieren in een werkruimte opvragen en één formulier met de bijbehorende structuur ophalen.
  • Inzendingen opvragen met filters: op formulier, status, datumbereik en volledige tekst, plus sorteren.
  • Eén inzending ophalen.
  • De status van een inzending bijwerken.
  • Programmatisch een formulier indienen, handig voor migraties of een eigen frontend.

Inzendingen ophalen

Authenticatie via de Authorization-header (een x-api-key-header werkt ook):

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 }

Aan de slag

  1. 1

    Een API-sleutel aanmaken

    Ga naar Instellingen → API-sleutels. De sleutel wordt maar één keer getoond, dus sla hem meteen op.

  2. 2

    Je eerste aanroep doen

    Probeer formulieren op te vragen om te controleren of de sleutel werkt en om het formulier-ID op te halen.

  3. 3

    Veld-ID's koppelen aan labels

    Het formulierdetail geeft het ID en het label van elk veld terug. Bouw daarmee een opzoektabel. Veld-ID's blijven stabiel, dus één keer ophalen is voldoende.

  4. 4

    Paginering afhandelen

    Het maximum is 100 inzendingen per verzoek. Heb je meer gegevens nodig, doorloop dan de pagina's tot je de laatste bereikt.

De API-sleutel hoort thuis op je server, nooit in JavaScript in de browser: daar kan iedereen hem uitlezen en al je antwoorden downloaden. Publiceer je antwoorden, toon dan alleen velden die bedoeld zijn voor publicatie, nooit persoonsgegevens.

Veelgestelde vragen

Hoe authenticeert de API?

Met een API-sleutel: via een Authorization: Bearer <key>-header of een x-api-key-header. Een ongeldige sleutel geeft 401 terug.

Hoeveel inzendingen per verzoek?

Maximaal 100. Het antwoord bevat total en totalPages, zodat je verder kunt pagineren.

Waarom zien de sleutels in de gegevens eruit als field_1778…?

Dat zijn de veld-ID's van het formulier. Haal hun labels op uit het formulierdetail en houd de koppeling zelf bij.

Ondersteunt de API diakritische tekens?

Ja, alles is UTF-8, dus Tsjechisch en andere talen werken zonder problemen.

Gerelateerd

Probeer Gatherino gratis

Gratis abonnement: 3 formulieren en 100 antwoorden per maand. Geen creditcard nodig, gegevens gehost in de EU.

Gratis aan de slag →