API da Avoei

A API da Avoei permite que outro sistema — o site da sua agência, um aplicativo ou uma ferramenta de automação — consulte os dados da sua agência no Avoei: as viagens publicadas, os dados da empresa, os depoimentos e as configurações de SEO.

Ela é indicada para quem desenvolve ou mantém a tecnologia de uma agência, ou para quem presta esse serviço a uma agência que usa o Avoei.

Esta é a área para desenvolvedores

Se você quer aprender a usar o Avoei no dia a dia (cadastrar clientes, criar viagens, gerar propostas), o lugar certo é o guia da plataforma. Esta área explica como outros sistemas se conectam ao Avoei.

O que você pode fazer

Recurso	O que a API entrega
Viagens	As viagens publicadas, com roteiro, itens inclusos, fotos, datas e preço. Com busca, filtros por data, ordenação e paginação.
Empresa	Nome, contatos, endereço, WhatsApp e identidade visual da agência.
Depoimentos	Os depoimentos de clientes exibidos no site de vendas.
SEO	Título, descrição e imagens de compartilhamento do site.

O que a API não faz

Nesta versão, a API é somente de leitura: ela não cria, altera nem exclui nada. Também não expõe dados de clientes, propostas, pagamentos ou passageiros. Ela entrega apenas informações que já são públicas no site de vendas da agência.

Como funciona

• Uma URL por agência. Cada agência acessa a API pelo seu próprio endereço, como https://minhaagencia.avoei.com.br/api/v1. Veja URLs e ambientes.
• Um token de API. Toda chamada envia um token no cabeçalho Authorization. Veja Autenticação.
• Respostas em JSON. Todas as respostas seguem um formato padrão.
• Versão 1. A versão faz parte do endereço (/api/v1).

Comece por aqui

1. Faça a primeira requisição

Gere um token, descubra o endereço da sua agência e consulte a API em poucos minutos.

Primeiros passos

2. Consulte a referência

Veja cada endpoint, seus parâmetros, as respostas possíveis e exemplos de código.

Referência da API

Próximos passos

• Autenticação e Tokens de API: como se identificar e como gerar ou revogar um token.
• Paginação, Filtros e Ordenação: como pedir exatamente os dados de que você precisa.
• Datas e horários: como ler as datas sem errar o dia.
• Erros e Boas práticas: como tratar falhas e integrar com segurança.

Prefere importar a API em uma ferramenta como o Postman ou o Insomnia? Baixe a especificação OpenAPI.