Ir para o conteúdo principal

Autenticação no Ambiente da A2B

A Autenticação na API A2B é um processo fundamental para garantir a segurança e o controle de acesso aos recursos da plataforma. Esse mecanismo utiliza uma Chave API como credencial de acesso, permitindo que apenas usuários autorizados interajam com o sistema.

1 - Obtenção da Chave API:

A Chave API é fornecida pela equipe responsável pela gestão da API A2B. Essa chave deve ser tratada como informação confidencial e armazenada de forma segura, evitando o compartilhamento com terceiros.


2 - Inclusão da Chave API nas Requisições:

A Chave API é incluída no cabeçalho (Authorization) de todas as requisições HTTP enviadas para a API A2B.
O formato do cabeçalho é o seguinte:

Authorization: API Key key={{vault:authorization-secret}}

  • key: Palavra-chave fixa que indica o tipo de autenticação.
  • {{vault:authorization-secret}}: Valor da Chave API obtida no passo anterior.

3 - Validação da Chave API:

Ao receber uma requisição, a API A2B verifica a validade da Chave API fornecida no cabeçalho Authorization.
Se a chave for válida, a requisição será processada. Caso contrário, a API retornará um erro de autenticação.


4 - Fluxograma:



Benefícios do Processo:
  • Segurança: Garante que apenas usuários autorizados acessem os recursos da API, protegendo informações sensíveis.
  • Simplicidade: O mecanismo de Chave API é simples de implementar e utilizar.
  • Eficiência: Elimina a necessidade de realizar múltiplas autenticações, agilizando o processo.

Em resumo, a Autenticação por Chave API na API A2B oferece um mecanismo seguro e eficiente para controlar o acesso aos recursos da plataforma. Ao seguir os passos descritos acima e utilizar a Chave API fornecida, você garante a segurança das suas integrações e otimiza o processo de desenvolvimento.