A API por trás do painel da Gomry.

REST sobre HTTPS, chaves API com permissões por recurso e notificações webhook para atividades Gomry suportadas.

Cria uma integração que leia eventos ou contactos, ou crie registos com as permissões que concederes. A tua equipa desenvolve a ligação à plataforma existente da Gomry; a API não é um serviço de desenvolvimento de sistemas de bilhética por encomenda.

Obter chaves API Ler a documentação

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.

Opções de entrega dos webhooks

Usa subscrições webhook assinadas com novas tentativas para eventos suportados de inscrição e respostas a formulários, ou URL webhook legados da organização com payloads e regras de entrega diferentes.

Paginação e limites

Os endpoints de listagens paginadas devolvem informações sobre as páginas. Consulta os limites de resposta de cada endpoint; o limite é de 60 pedidos por 10 segundos por chave de API, com a mesma margem por endereço IP. As respostas incluem cabeçalhos RateLimit, e um 429 inclui Retry-After.

Escolhe como os teus sistemas recebem atualizações.

Configura notificações para a atividade Gomry de que a tua integração precisa. A API de subscrições webhook e os URL legados do painel têm tipos de eventos, payloads e regras de entrega diferentes.

Subscrições webhook assinadas

Cria subscrições pela API ou deixa que o Zapier as crie para os seus triggers instantâneos. Escolhe inscrições através do checkout ou eventos de respostas a formulários, com filtro por evento ou formulário quando suportado.

Os payloads incluem um ID de evento estável. Os cabeçalhos de entrega contêm uma assinatura HMAC-SHA256. Tempos de espera excedidos, erros de rede e respostas 429 ou 5xx originam novas tentativas com esperas crescentes. As restantes respostas 4xx não. Os eventos podem chegar mais de uma vez ou fora de ordem.

URL webhook legados da organização

Para integrações existentes, acrescenta URL HTTPS em Organization Settings → API Keys → Webhooks. Cada URL recebe os eventos legados suportados da organização relativos a pagamentos, subscrições e formulários.

Este mecanismo usa payloads legados sem assinatura nem novas tentativas. Antes de agir sobre dados de pagamento sensíveis, o teu recetor confirma o pagamento pela API.

Envia inscrições para o CRM que já usas

Para acrescentar ao CRM participantes inscritos através do checkout, o teu programador disponibiliza um recetor HTTPS, verifica as assinaturas das subscrições e associa os dados dos participantes aos campos da API do CRM. A integração deve tratar entregas repetidas e definir que registos criar ou atualizar. Configurar um destino webhook não cria, por si só, uma sincronização contínua.

Configuração e entrega dos webhooks

Referência

Algumas das chamadas que vais usar.

Método	Endpoint	Função
GET	/api/v1/events	Lista os teus eventos, com paginação.
POST	/api/v1/events	Cria um evento.
GET	/api/v1/events/:id/attendees	Participantes de um evento, com o estado do bilhete.
GET	/api/v1/events/:id/ticket-classes	Tipos de bilhete com preço e capacidade.
GET	/api/v1/payments	Pagamentos de toda a organização.
POST	/api/v1/contacts	Cria um contacto.