Resumo
Este artigo explica como configurar a autenticação para ações de API REST no Astra. Ele aborda os métodos de autenticação suportados, quando usar cada um e como configurá-los corretamente para que suas solicitações de API sejam aceitas.
Instruções
A autenticação informa a um sistema externo que a solicitação proveniente do Astra é permitida. Ao configurar uma ação de API REST, você pode escolher um dos métodos de autenticação suportados com base no que sua API exige.
Atualmente, o Astra suporta as seguintes opções de autenticação:
Autenticação por chave de API
Autenticação básica
Sem autenticação
Autenticação por chave de API
Este é o método de autenticação mais comum usado por APIs modernas.
Com a autenticação por chave de API, você envia uma chave ou token nos cabeçalhos da solicitação.
O que você precisa fornecer
auth_key: O nome do cabeçalho HTTP (por exemplo,
AutorizaçãoouX-API-Key)auth_value: O valor enviado no cabeçalho (por exemplo,
Bearer seu-token)
Padrões comuns
Tipo de serviço | Nome do cabeçalho | Formato do valor do cabeçalho |
A maioria das APIs |
|
|
APIs personalizadas |
|
|
Serviços de webhook |
|
|
Certifique-se de que o nome e o valor do cabeçalho correspondam exatamente ao que a documentação da sua API espera.
Autenticação básica
A autenticação básica é normalmente usada por sistemas mais antigos ou legados. Com este método:
Você fornece um nome de usuário e senha
O Astra envia essas credenciais usando a autenticação básica HTTP padrão
Sem autenticação
Alguns endpoints de webhook públicos não exigem autenticação.
Dicas para uma configuração bem-sucedida
Confirme o método de autenticação necessário na documentação da sua API
Verifique os nomes dos cabeçalhos, valores e formatos de token
Teste a ação de API REST após salvar para garantir que a autenticação esteja funcionando
Escolher o método de autenticação correto garante que as ações de API REST funcionem de forma suave e segura.