REST API

Kun haluat näyttää vastauksia omalla sivustollasi tai hakea niitä järjestelmääsi ajastetusti, käytä REST API -rajapintaa. Se palauttaa dataa JSON-muodossa, tunnistautuu API-avaimella ja tukee samoja suodattimia, jotka tunnet vastaustaulukosta.

Aloita ilmaiseksi →Hinnoittelu

Hyvä tietää: Gatherino-editori ja käyttäjätili ovat englanniksi tai tšekiksi. Vastaajille näytettävät lomakkeet voi näyttää 18 kielellä, myös suomeksi.

Mitä API:lla voi tehdä

  • Listaa työtilan lomakkeet ja hae yksittäinen lomake rakenteineen.
  • Listaa vastaukset suodattimilla: lomakkeen, tilan, päivämäärävälin ja kokotekstihaun mukaan sekä lajittele tulokset.
  • Hae yksittäinen vastaus.
  • Päivitä vastauksen tila.
  • Lähetä lomake ohjelmallisesti – hyödyllinen esimerkiksi tietojen siirrossa tai omassa käyttöliittymässä.

Vastausten hakeminen

Tunnistautuminen Authorization-otsakkeella (myös x-api-key-otsake toimii):

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 }

Aloittaminen

  1. 1

    Luo API-avain

    Löydät sen kohdasta Asetukset → API-avaimet. Avain näytetään vain kerran, joten tallenna se heti.

  2. 2

    Tee ensimmäinen kutsu

    Kokeile lomakkeiden listausta varmistaaksesi, että avain toimii, ja hae samalla lomakkeen ID.

  3. 3

    Yhdistä kenttien ID:t nimiin

    Lomakkeen tiedot palauttavat kunkin kentän ID:n ja nimiön – rakenna niistä hakutaulukko. Kenttien ID:t ovat pysyviä, joten riittää hakea ne kerran.

  4. 4

    Sivutus

    Yhdessä pyynnössä saa olla enintään 100 vastausta. Jos tarvitset lisää tietoja, käy sivut läpi viimeiselle sivulle asti.

API-avain kuuluu palvelimellesi, ei koskaan selaimen JavaScriptiin – sieltä kuka tahansa voisi lukea sen ja ladata kaikki vastauksesi. Jos julkaiset vastauksia, näytä vain julkaisuun tarkoitetut kentät, älä koskaan henkilötietoja.

UKK

Miten API tunnistautuu?

API-avaimella: joko Authorization: Bearer <key> -otsakkeella tai x-api-key-otsakkeella. Virheellinen avain palauttaa virhekoodin 401.

Montako vastausta yhdessä pyynnössä?

Enintään 100. Vastaus sisältää kentät total ja totalPages, joiden avulla voit käydä läpi lisää sivuja.

Miksi datan avaimet ovat muotoa field_1778…?

Ne ovat lomakkeen kenttien ID:itä. Hae niiden nimiöt lomakkeen tiedoista ja pidä vastaavuustaulukko omassa järjestelmässäsi.

Tukeeko API ääkkösiä?

Kyllä, kaikki data on UTF-8-koodattua, joten tšekin kieli ja muut kielet toimivat ilman ongelmia.

Aiheeseen liittyvää

API-dokumentaatioWebhookitVastausten hallintaDiscordGoogle Sheets

Kokeile Gatherinoa ilmaiseksi

Ilmainen paketti: 3 lomaketta ja 100 vastausta kuukaudessa. Ei luottokorttia, tiedot isännöidään EU:ssa.

Aloita ilmaiseksi →