API stojące za panelem Gomry.

REST przez HTTPS, klucze API z uprawnieniami zasobów i powiadomienia webhook o obsługiwanych działaniach w Gomry.

Stwórz integrację, która odczytuje wydarzenia lub kontakty albo tworzy rekordy w ramach przyznanych przez ciebie uprawnień. Twój zespół tworzy połączenie z istniejącą platformą Gomry; API nie jest usługą tworzenia systemów biletowych na zamówienie.

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.

Sposoby dostarczania webhooków

Użyj podpisanych subskrypcji webhook z ponowieniami dla obsługiwanych rejestracji i odpowiedzi na formularze albo starszych adresów webhook organizacji z innym formatem danych i zasadami dostarczania.

Paginacja i limity

Endpointy list ze stronicowaniem zwracają informacje o stronach. Sprawdź limity odpowiedzi każdego endpointu; limit wynosi 60 zapytań na 10 sekund na klucz API, z takim samym limitem na adres IP. Odpowiedzi zawierają nagłówki RateLimit, a odpowiedź 429 zawiera Retry-After.

Wybierz, jak twoje systemy otrzymują aktualizacje.

Skonfiguruj powiadomienia o działaniach w Gomry potrzebnych twojej integracji. API subskrypcji webhook i starsze adresy URL w panelu mają różne typy zdarzeń, formaty danych i zasady dostarczania.

Podpisane subskrypcje webhook

Utwórz subskrypcje przez API lub pozwól Zapier tworzyć je dla swoich natychmiastowych wyzwalaczy. Wybierz zdarzenia rejestracji przez checkout lub odpowiedzi na formularze, z filtrem wydarzenia lub formularza tam, gdzie jest obsługiwany.

Dane zawierają stały identyfikator zdarzenia. Nagłówki dostarczenia zawierają podpis HMAC-SHA256. Przekroczenie czasu oczekiwania, błędy sieci oraz odpowiedzi 429 lub 5xx uruchamiają ponowienia z rosnącymi odstępami. Inne odpowiedzi 4xx nie powodują ponowień. Zdarzenia mogą dotrzeć wielokrotnie lub poza kolejnością.

Starsze adresy webhook organizacji

Dla istniejących integracji dodaj adresy HTTPS w Organization Settings → API Keys → Webhooks. Każdy adres otrzymuje obsługiwane starsze zdarzenia organizacji dotyczące płatności, subskrypcji i formularzy.

Ta ścieżka używa starszego formatu danych bez podpisów i ponowień. Zanim twój odbiornik podejmie działanie na podstawie wrażliwych danych płatniczych, potwierdza płatność przez API.

Wysyłaj rejestracje do używanego już CRM

Aby dodawać do CRM uczestników rejestrujących się przez checkout, programista przygotowuje odbiornik HTTPS, weryfikuje podpisy subskrypcji i przypisuje dane uczestników do pól API CRM. Integracja musi obsługiwać powtórne dostarczenia i określać, które rekordy tworzyć lub aktualizować. Samo ustawienie adresu webhook nie uruchamia ciągłej synchronizacji.

Konfiguracja i dostarczanie webhooków

Referencja

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

MetodaEndpointFunkcja
GET/api/v1/eventsWyświetl swoje wydarzenia, z podziałem na strony.
POST/api/v1/eventsUtwórz wydarzenie.
GET/api/v1/events/:id/attendeesUczestnicy wydarzenia ze statusem biletu.
GET/api/v1/events/:id/ticket-classesRodzaje biletów z ceną i limitem miejsc.
GET/api/v1/paymentsPłatności w całej organizacji.
POST/api/v1/contactsUtwórz kontakt.

Utwórz klucz i wyślij pierwsze żądanie.