Pular para o conteúdo principal

Autenticação

Autenticação​

Antes de conseguir realizar operações de integração no sistema e realizar ações como se inscrever para receber eventos ou processar uma carga de dados, é necessário entender como se autenticar.

A autenticação utilizada no sistema de integração se baseia no esquema de "Basic Auth". Uma chave pública (ClientId) e uma chave secreta (ClientSecret) será gerada e enviada pelos meios oficiais de contato.

Basic Auth​

É necessário passar o seguinte "Header" em toda requisição:

  • Authorization: Basic Auth contendo o ClientId e ClientSecret disponibilizados para o cliente.
    • Formado utilizando uma concatenação da palavra chave "Basic" e das duas chaves separadas por ":" codificadas utilizando a codificação base 64.
    • Exemplo não codificado em base 64: Basic clientId:clientSecret
    • Exemplo codificado: Basic VXNlcm5hbWU6UGFzc3dvcmQ=

Header Auxiliar​

Além da autenticação, a maioria dos endpoints requer o header x-contractAccountId:

  • x-contractAccountId: Identificador da conta do contrato do cliente.
    • Exemplo: x-contractAccountId: 9f36a666-acd5-4987-a47f-3de247f65d82