Pular para o conteúdo principal

API Tokens

Você provavelmente não precisa desta página

Esta é uma funcionalidade técnica, voltada para agências que têm um desenvolvedor ou uma ferramenta externa que precisa se conectar ao Avoei por conta própria (fora do site de vendas integrado). Se você não usa nenhuma integração personalizada, pode ignorar esta seção com tranquilidade.

A tela API Tokens permite gerar chaves de acesso que autorizam sistemas externos a consultar os dados públicos da sua agência no Avoei — como as viagens publicadas, os dados da empresa e os depoimentos — através da API. Com um token, o sistema externo só consegue ler essas informações: ele não altera nada na sua conta.

Para acessar, vá em Configurações > API Tokens no menu lateral. Se essa opção não aparece para você, peça a uma pessoa administradora para liberar a permissão Tokens de API no seu perfil (veja Papéis e Permissões).

Como gerar um novo token​

  1. Clique no botão "Criar API Token".
  2. Preencha o campo Nome, dando um apelido que ajude você a lembrar para que serve esse token (Ex: Integração com sistema de contabilidade).
  3. Clique em Criar.

Você será redirecionado para a página do token recém-criado, que exibirá o código gerado em uma seção chamada "Token gerado".

Copie agora — você não verá esse código de novo

Por segurança, o token completo só é exibido uma única vez, logo após a criação. Clique no ícone de cópia ao lado do código e guarde-o em um lugar seguro. Se você perder o token, será necessário excluí-lo e gerar um novo.

Gerenciando tokens existentes​

Na listagem, você verá todos os tokens já criados pelo nome que você deu a eles (o código em si nunca é exibido novamente, mesmo para você). Se um token não for mais necessário — por exemplo, se uma integração foi desativada — exclua-o clicando no ícone de lixeira para revogar o acesso imediatamente.

Um token não tem data de validade: ele vale até você excluí-lo. Por isso, vale a pena revisar a lista de tempos em tempos e excluir o que não estiver mais em uso.

Cuidados com o token​

  • Trate o token como uma senha: quem o tem consegue consultar os dados públicos da sua agência pela API.
  • Envie o token apenas para a pessoa ou empresa responsável pela integração, e não o compartilhe por e-mail, grupos de mensagem ou capturas de tela.
  • Crie um token para cada sistema (por exemplo, um para o site e outro para uma automação). Assim você exclui o acesso de um sem afetar o outro.
  • Se suspeitar que um token vazou, exclua-o na hora e gere outro.

Para quem vai fazer a integração​

Passe ao desenvolvedor o token e o endereço do seu site de vendas. Ele encontra o passo a passo técnico — autenticação, exemplos de código e a lista dos dados disponíveis — na documentação para desenvolvedores.