Saltar para o conteúdo

Autenticar um pedido à 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 acesso programático está disponível em https://api.threetone.in. Envie a chave de API no cabeçalho x-api-key do pedido:

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

Utilize a chave como valor do cabeçalho. Não a coloque num URL, numa cadeia de consulta ou no corpo do pedido. Um pedido programático deve enviar x-api-key; o envio simultâneo de um cabeçalho Authorization é rejeitado por ser ambíguo.

Mantenha a chave no servidor

Carregue a chave a partir de um gestor de segredos no servidor ou de uma variável de ambiente. Não a inclua em JavaScript da interface, pacotes de aplicações móveis, registos ou mensagens de erro. Utilize uma chave separada e com permissões limitadas para cada integração implementada, para que a divulgação de uma credencial não exponha operações sem relação.

Registe o ID do pedido

A Threetone devolve um cabeçalho de resposta X-Request-Id. Guarde este valor com a hora, o método, o caminho e o estado do pedido para resolver problemas. Também pode enviar um X-Request-Id válido; a API devolve-o na resposta.

Artigos relacionados