API

API stojące za panelem Gomry.

REST przez HTTPS, klucze API z zakresami per zasób, webhooki dla płatności, formularzy i subskrypcji.

events.tswebhooks.ts
// List your events. Same endpoint the dashboard uses.
const res = await fetch(
  "https://www.gomry.com/api/v1/events?page=1&page_size=20",
  { headers: { "X-API-KEY": process.env.GOMRY_API_KEY } }
);
const { data, pagination } = await res.json();

// Attendees for the first event.
const attendees = await fetch(
  `https://www.gomry.com/api/v1/events/${data[0].id}/attendees`,
  { headers: { "X-API-KEY": process.env.GOMRY_API_KEY } }
).then(r => r.json());
Dlaczego to ważne

Jedno API, panel w zestawie.

API obejmuje spaces, wydarzenia, doświadczenia, cykle, klasy biletów, uczestników, kontakty, listy, formularze, zgłoszenia, płatności i pola własne. Klucze tworzy się w Ustawienia organizacji → API Keys.

Uwierzytelnianie i zakresy

Klucze API w nagłówku X-API-KEY. Każdy klucz ma mapę zakresów: none, read lub write na zasób. Dowolny język przez HTTPS.

Webhooki

Dziś pięć typów zdarzeń: płatność zrealizowana, odpowiedź z formularza utworzona i zaktualizowana, subskrypcja utworzona i usunięta. Dostarczanie jest best-effort i niepodpisane, więc potwierdź przez API przed działaniem.

Paginacja i limity

Listowanie stronami w każdej kolekcji. Limity zapytań na klucz są udokumentowane.

Referencja

Kilka wywołań, których użyjesz.

POST
Lista twoich wydarzeń, z paginacją.
POST
Utwórz wydarzenie.
GET
Uczestnicy wydarzenia, ze statusem biletu.
POST
Klasy biletów z ceną i pojemnością.
POST
Płatności całej organizacji.
Utwórz kontakt.
Utwórz klucz i wykonaj pierwsze wywołanie.