Skip to main content
Todas as operações privadas da API exigem uma chave da Airbee. A chave identifica a conta responsável pela requisição e deve ser usada somente em sistemas controlados por você.

Criar uma chave

No painel da Airbee, abra Configurações > API e selecione Nova chave. Dê um nome que identifique a integração, como Sistema de reservas ou Automação interna. O segredo completo é exibido uma única vez. Copie-o e armazene-o em um gerenciador de segredos ou em uma variável de ambiente do seu servidor.
Trate a chave como uma senha. Não a coloque em código de frontend, aplicativos distribuídos, repositórios ou mensagens de suporte.

Enviar a chave

Envie a chave no cabeçalho Authorization, usando o esquema Bearer:
Um modelo de requisição fica assim:
Substitua RECURSO pelo caminho de uma operação publicada nesta referência.

Escopo da conta

A Airbee determina a conta a partir da chave recebida. Uma integração não pode escolher outra conta enviando um identificador no corpo, na URL ou nos parâmetros da requisição. Crie chaves separadas para integrações diferentes. Isso facilita identificar o uso de cada credencial e revogar apenas o acesso necessário.

Revogar ou trocar uma chave

Para interromper o acesso, abra Configurações > API e revogue a chave. Requisições posteriores com essa credencial deixam de ser autenticadas. Para trocar uma chave sem interromper a integração:
1

Crie uma nova chave

Use um nome que identifique a nova versão ou o sistema que receberá a credencial.
2

Atualize a integração

Substitua a variável de ambiente e confirme que as requisições usam a nova chave.
3

Revogue a chave anterior

Revogue a credencial antiga somente depois que ela não estiver mais em uso.

Falhas de autenticação

Requisições sem uma chave válida, com uma chave malformada ou com uma chave revogada retornam 401 Unauthorized. Nunca registre a chave completa ao tratar um erro. Se precisar identificar a credencial usada, consulte o nome e os últimos caracteres exibidos no painel da Airbee.