Integração por JWT | Central de Ajuda

Segundo Passo - Autenticação JWT

Você deve fornecer as informações do cabeçalho da integração conforme as especificações da API desejada, veja um exemplo abaixo:

JSON

// URL:
"https://api.tenant.com/v1/"

// Autenticação:
"https://api.tenant.com/v1/auth"

// Método HTTP:
"POST"

// Headers
{
    "Content-type": "application/json"
}

// Request Body:
{
    "username": "usuario-integracao",
    "password": "@[CV-PASS-senha-integracao]"
}

// Response
{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Neste exemplo de JSON, a autenticação ocorre por meio do login de um usuário de integração e da respectiva senha, e a API retorna dinamicamente um access_token. Em vez de informar a senha em texto aberto, o campo password recebe a referência de uma Chave Segura no formato @[chave].

Nota: utilize um usuário dedicado à integração, com apenas as permissões necessárias, em vez das credenciais de um usuário administrador ou pessoal. Isso limita o alcance da integração e facilita a troca da credencial quando preciso.

Cabeçalho

As configurações devem ser feitas dessa maneira, na seção Autenticação JWT :

1. Digite a URL para autenticação e na aba Cabeçalhos clique no botão Adicionar Campo. Note que surgem duas caixas de textos:

2. Insira o rótulo do campo, exemplo: Content-type.
3. Insira o valor que será preenchido no campo: application/json.

Nota: Repita essa operação para quantos campos são necessários para completar o Cabeçalho da integração (Headers).
Na seção seguinte dos cabeçalhos é obrigatório ter os campos cadastrados:

Corpo

Na próxima etapa é destinada à Configuração do Corpo, você deverá inserir as informações dessa seção. Normalmente está relacionado a textos com a palavra Body.

Basta copiar e colar as informações de sua integração neste campo.

Atenção
Não informe a senha em texto aberto no corpo da autenticação. Cadastre a senha como uma Chave Segura e utilize a referência no formato @[chave] no campo password. Ao executar a integração, a plataforma substitui a referência pelo valor protegido. Saiba mais na página [Chaves Seguras].

Terceiro passo: cadastrar as Operações da API.