Pular para o conteúdo

Autentique uma solicitação à API

Envie uma chave de API da Threetone no cabeçalho x-api-key e mantenha a credencial fora do código do cliente.

Atualizado em

Envie o cabeçalho da chave de API

A API pública para uso programático fica em https://api.threetone.in. Envie a chave no cabeçalho x-api-key da solicitação:

curl --request GET \
  --url 'https://api.threetone.in/v1/convai/agents' \
  --header "x-api-key: $THREETONE_API_KEY"

Use a chave como valor do cabeçalho. Não a coloque na URL, na string de consulta ou no corpo. A solicitação programática deve enviar x-api-key; se também enviar Authorization, será rejeitada por ambiguidade.

Mantenha a chave no servidor

Carregue a chave de um gerenciador de segredos no servidor ou de uma variável de ambiente. Não a inclua no JavaScript do frontend, no pacote do aplicativo móvel, em logs ou mensagens de erro. Use uma chave separada e com escopo restrito para cada integração implantada, de modo que um vazamento não exponha operações não relacionadas.

Registre o ID da solicitação

A Threetone devolve o cabeçalho X-Request-Id. Ao investigar, guarde esse valor com a data e hora, o método, o caminho e o status. Você também pode enviar um X-Request-Id válido; a API o repetirá na resposta.

Artigos relacionados