REST API

Gdy chcesz wyświetlać odpowiedzi na swojej stronie albo cyklicznie przenosić je do swojego systemu, skorzystaj z REST API. Zwraca dane w formacie JSON, uwierzytelnia się kluczem API i obsługuje te same filtry, które znasz z tabeli wyników.

Warto wiedzieć: edytor Gatherino i konto są dostępne po angielsku lub czesku. Formularze wypełniane przez respondentów mogą być wyświetlane w 18 językach, w tym po polsku.

Co potrafi API

  • Pobierz listę formularzy w przestrzeni roboczej oraz pojedynczy formularz wraz z jego strukturą.
  • Pobieraj zgłoszenia z filtrami: według formularza, statusu i zakresu dat oraz z wyszukiwaniem pełnotekstowym, a także sortuj wyniki.
  • Pobierz pojedyncze zgłoszenie.
  • Zmieniaj status zgłoszenia.
  • Wysyłaj zgłoszenia do formularza programowo – przydatne przy migracjach lub we własnym froncie.

Pobieranie zgłoszeń

Uwierzytelnianie nagłówkiem Authorization (działa też nagłówek 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 }

Pierwsze kroki

  1. 1

    Utwórz klucz API

    Znajdziesz go w Ustawienia → Klucze API. Klucz jest wyświetlany tylko raz, więc od razu zapisz go w bezpiecznym miejscu.

  2. 2

    Wykonaj pierwsze zapytanie

    Sprawdź listę formularzy, aby upewnić się, że klucz działa, i odczytać ID formularza.

  3. 3

    Połącz ID pól z etykietami

    Szczegóły formularza zwracają ID i etykietę każdego pola – na ich podstawie zbuduj słownik. ID pól są stałe, więc wystarczy pobrać je raz.

  4. 4

    Obsługa stronicowania

    Maksymalnie 100 zgłoszeń w jednym zapytaniu. Aby pobrać więcej danych, przechodź kolejne strony aż do ostatniej.

Klucz API powinien znajdować się na Twoim serwerze, nigdy w kodzie JavaScript w przeglądarce – każdy mógłby go tam odczytać i pobrać wszystkie Twoje odpowiedzi. Jeśli publikujesz odpowiedzi, udostępniaj wyłącznie pola przeznaczone do publikacji, nigdy danych osobowych.

FAQ

Jak API się uwierzytelnia?

Kluczem API, przesyłanym w nagłówku Authorization: Bearer <klucz> lub w nagłówku x-api-key. Nieprawidłowy klucz zwraca kod 401.

Ile zgłoszeń można pobrać w jednym zapytaniu?

Do 100. Odpowiedź zawiera pola total i totalPages, dzięki którym możesz przechodzić kolejne strony.

Dlaczego klucze danych wyglądają jak field_1778…?

To ID pól formularza. Pobierz ich etykiety ze szczegółów formularza i zachowaj mapowanie po swojej stronie.

Czy API obsługuje polskie znaki diakrytyczne?

Tak, wszystko działa w UTF-8, więc czeskie znaki i inne języki nie sprawiają problemów.

Powiązane

Wypróbuj Gatherino za darmo

Plan darmowy: 3 formularze i 100 odpowiedzi miesięcznie. Bez karty kredytowej, dane hostowane w UE.

Zacznij za darmo →