excursso.
API

Conecte a sua agência ao que você já usa.

Planilhas, automações como n8n, Make ou Zapier, e sistemas próprios leem e cadastram excursões, saídas e reservas com uma chave da agência.

Como funciona

  • Chave da agência

    Criada no painel, em Configurações › API e MCP. Ela aparece uma única vez: copie e guarde.

  • Você escolhe o acesso

    Somente leitura, leitura e escrita, ou permissão por permissão. A chave nunca pode mais do que quem a criou.

  • Corte na hora

    Revogue quando quiser. Se quem criou a chave sair da equipe, ela para de funcionar.

  • Referência completa

    Todas as rotas disponíveis, com parâmetros, corpo e exemplo, e o documento OpenAPI 3.1 para baixar.

  • Só no servidor

    A chave é para uso entre servidores. Pedidos feitos de um navegador com a chave são recusados.

  • Validade

    30, 90 ou 365 dias, ou até você revogar. O painel mostra quando cada chave foi usada pela última vez.

Como conectar

  1. Crie uma chave

    No painel, em Configurações › API e MCP, toque em Nova chave, dê um nome e escolha o acesso e a validade. Copie a chave na hora.

  2. Chame a API

    Envie a chave no cabeçalho Authorization.

    Listar as excursões da agência
    curl <endereço-da-api>/api/organizations/<id-da-agência>/excursions \
      -H "Authorization: Bearer exc_live_<sua-chave>"
  3. Consulte a referência

    A referência da API mostra cada rota que uma chave pode chamar, com parâmetros, corpo e exemplo. O documento OpenAPI 3.1 também está lá, para baixar e importar no Postman, no Insomnia ou no seu gerador de cliente.

  4. Trate os erros

    Erros respondem JSON com error, code e requestId. 401: chave inválida, expirada ou revogada. 403: sem permissão. 429: limite atingido.

Permissões de uma chave

Somente leitura

excursion:read
Ver excursões.
departure:read
Ver saídas.
booking:read
Ver reservas.
passenger:read
Ver passageiros.
payment:read
Ver pagamentos.
finance:read
Ver financeiro.
fleet:read
Ver frota.
checkin:read
Ver embarque.

Leitura e escrita (acrescenta)

excursion:create
Criar excursões.
excursion:update
Editar excursões.
excursion:publish
Publicar excursões.
departure:create
Criar saídas.
departure:publish
Publicar saídas.
booking:create
Criar reservas.
booking:update
Alterar reservas.
passenger:update
Alterar passageiros.
payment:create
Registrar pagamentos.
payment:refund
Estornar pagamentos.
finance:manage
Gerenciar despesas.
fleet:manage
Gerenciar frota.
checkin:manage
Registrar embarque.

Só escolhendo uma a uma

organization:manage
Configurações da agência, como perfil público, cupons e regras.

Limites de hoje

  • Versão v1 em beta: rotas e respostas ainda podem mudar, sempre refletidas na referência.
  • 300 requisições por minuto por chave. As respostas trazem X-RateLimit-Limit e X-RateLimit-Remaining; acima do limite, 429 com Retry-After.
  • Uma chave não gerencia equipe, outras chaves nem conexões de pagamento.
  • Cada chave abre só a agência em que foi criada.

Perguntas frequentes

O que acontece se a pessoa que criou a chave sair da equipe?

A chave para de funcionar na hora.

Posso usar a chave no site ou no aplicativo do meu cliente?

Não. A chave dá acesso aos dados da agência e é recusada quando vem de um navegador. Use-a só no seu servidor.

A mesma chave serve para o MCP?

Serve, com as mesmas permissões. No MCP, as alterações continuam esperando aprovação no painel.

Vista aérea de um morro verde à beira-mar no litoral do Rio de Janeiro

Quer ver as ações em funcionamento?

A demonstração do painel tem o assistente com as operações de consulta, usando dados de exemplo.