Ir para o conteúdo principal

Autenticação no Ambiente da A2B

A autenticaçAutenticação na API A2B utilizaé um processo fundamental para garantir a segurança e o controle de acesso aos recursos da plataforma. Esse mecanismo deutiliza uma Chave API. Essacomo chavecredencial éde umacesso, identificador únicopermitindo que associaapenas umausuários determinadaautorizados aplicaçãinterajam com o ou usuário ao sistema. Ao incluir a chave API nas suas requisições, você está informando à API que você tem permissão para acessar os recursos solicitados.

Processo de Autenticação:

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 chaveChave API é incluída no cabeçalho (Authorization)Authorization) de todas as requisições HTTP enviadas para a API A2B.A2B

  • .
    O formato do cabeçalho é o seguinte:

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

  • Key:key: Palavra-chave fixa que indica o tipo de autenticação.
  • {{vault:authorization-secret}}:  Valor da chaveChave 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çAutenticação por Chave API na API A2B éoferece um processomecanismo simples,seguro mase crucialeficiente para garantircontrolar ao segurançaacesso aos recursos da sua integração.plataforma. Ao seguir os passos descritos acima e utilizar a Chave API fornecida, você poderágarante realizara assegurança operaçdas suas integrações necessáriase naotimiza APIo processo de forma segura e eficiente.desenvolvimento.