API

A API por trás do painel da Gomry.

REST sobre HTTPS, chaves API com scopes por recurso, webhooks para pagamentos, formulários e subscrições.

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());
Porque importa

Uma só API, painel incluído.

A API cobre spaces, eventos, experiências, recorrências, classes de bilhete, participantes, contactos, listas, formulários, candidaturas, pagamentos e campos personalizados. As chaves criam-se em Definições da organização → API Keys.

Autenticação e scopes

Chaves API enviadas no cabeçalho X-API-KEY. Cada chave tem um mapa de scopes: none, read ou write por recurso. Qualquer linguagem sobre HTTPS.

Webhooks

Cinco tipos de evento hoje: pagamento concluído, resposta a formulário criada e atualizada, subscrição criada e eliminada. A entrega é best-effort e sem assinatura: confirma pela API antes de agir.

Paginação e limites

Listagens paginadas em cada coleção. Os limites de pedidos por chave estão documentados.

Referência

Algumas das chamadas que vais usar.

POST
Lista os teus eventos, com paginação.
POST
Cria um evento.
GET
Participantes de um evento, com o estado do bilhete.
POST
Classes de bilhete com preço e capacidade.
POST
Pagamentos de toda a organização.
Cria um contacto.
Cria uma chave e faz a primeira chamada.