Pular para o conteúdo principal

URLs e ambientes

O Avoei atende várias agências ao mesmo tempo, e cada uma tem os seus próprios dados. Por isso, não existe uma URL única para a API: cada agência usa o próprio endereço.

O endereço da API​

A URL de qualquer endpoint tem três partes:

https://minhaagencia.avoei.com.br/api/v1/travels
└──────────────┬───────────────┘└──┬──┘└───┬───┘
        endereço da agência     versão   endpoint
  • Endereço da agência: o mesmo endereço em que os clientes acessam o site de vendas da agência. Pode ser um endereço no Avoei, como minhaagencia.avoei.com.br, ou o domínio próprio da agência, quando ele está configurado.
  • /api/v1: o caminho fixo da API e a sua versão.
  • Endpoint: o recurso que você quer consultar, como /travels ou /companies.

Por exemplo, para a agência minhaagencia, a base é https://minhaagencia.avoei.com.br/api/v1.

Como descobrir o endereço?

Abra o site de vendas da agência no navegador e copie o endereço até o final do domínio, sem o caminho da página. É esse endereço que você usa, seguido de /api/v1.

Cada token vale para um endereço​

Um token só funciona no endereço da agência que o criou. Se você presta serviço a várias agências, guarde o endereço e o token de cada uma, e use sempre o par correto. Veja Autenticação.

Chamadas feitas para o endereço principal do Avoei (avoei.com.br) ou para um endereço que não pertence a nenhuma agência não funcionam: normalmente a resposta é 404.

Use sempre HTTPS​

Faça todas as requisições com https://. O token é enviado em cada requisição, e o HTTPS protege esse envio.

A versão​

A versão faz parte do caminho: hoje, a única versão é a v1. Ao integrar, use sempre o caminho completo, com /api/v1.

Ambiente de testes​

Esta documentação descreve o ambiente de produção da Avoei. Como a API é somente de leitura, você pode testar a sua integração diretamente na sua agência sem risco de alterar dados: nenhuma requisição cria, edita ou exclui informações.

Mesmo assim, prefira usar um token exclusivo para os testes, com um nome claro (por exemplo, Testes de integração), e exclua-o quando terminar.

Nos exemplos da documentação​

Nos exemplos usamos minhaagencia.avoei.com.br e SEU_TOKEN como valores de exemplo. Troque os dois pelos dados reais da sua agência.