Como cadastrar uma integração REST

Para cadastrar uma integração basta seguir os passos:  acesse   Configurações  >  Geral  >  Integrações.   Sugirá a tela de Integração Externa.  

A tela de integrações é dividida em 3 sessões:

1. Nestes campos você deve informar os dados de integração, como nome da conexão, tipo e URL da API.
2.  Configurações de autenticação JWT (opcional).
3. Operação, comando para adicionar os métodos de GET, POST, PUT e DELETE para tratar os dados da API (você pode adicionar, várias operações para uma mesma integração).

Primeiro Passo - Informações da Integração

Para acessar e configurar uma integração, siga os passos: acesse   Configurações  >  Geral  >  Integrações   e clique no botão  Adicionar  .

Na tela de Informações da Integração Externa preencha os dados da integração: 

• Nome da Integração  : Insira um nome descritivo para a integração, por exemplo, se estiver realizando uma consulta para recuperar dados do cliente, coloque um nome que facilite a identificação dessa consulta, como: Dados do Cliente. 
• Tipo de integração  : Escolha REST.
• URL Base  : Insira uma URL base que sirva como ponto de acesso principal para a API que você está integrando. 

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

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

// Autentication:
"http://api.tenant.com/v1/auth"

// Método HTTP: 
"GET"

// Headers
{    "Content-type": "application/json"
}
// Request Body:
{    "username": "tenant-admin",    "password": "*******"
}
// Response
{    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Escolha o método de autenticação

Tipo de Autenticação

Na plataforma é possível configurar os seguintes tipos de autenticação: 

Mensagens de erro