Passar para o conteúdo principal

Integrando via API REST (API dos Usuários)

Este artigo ensina a configurar a autenticação de usuários consultando sistemas externos via requisições REST. É a solução ideal para integrar CRMs, ERPs ou bancos de dados legados que não suportam protocolos padrão como LDAP ou SAML.

Atualizado há mais de 2 semanas

Acesso ao Módulo de Configuração

  1. Acesse o menu Configurations > Integrações.

  2. Selecione a aba API de Usuários.

  3. Clique em Adicionar


Conceito de Variáveis Dinâmicas

O sistema utiliza tags reservadas para injetar as credenciais fornecidas pelo usuário na requisição HTTP. Estas tags devem ser inseridas na URL ou no Corpo (Body) da chamada.

  • ${username}: Substituído pelo login digitado pelo usuário.

  • ${password}: Substituído pela senha digitada pelo usuário.


Parâmetros de Configuração

Identificação e Endpoint

Descrição

Campo usado para identificar o nome da integração.

Exemplo: Validação ERP

Método e URL

Método: Selecione o verbo HTTP da API (Geralmente POST ou GET).

URL: Endereço completo do endpoint.

Headers (Cabeçalhos)

Define metadados da requisição (Chave/Valor).

  • Chave (Key): Nome do cabeçalho

Exemplo: Content-Type, Authorization

  • Valor (Value): Conteúdo do cabeçalho

Exemplo: application/json, Bearer [TOKEN]

Dica: Utilize o botão de adicionar (+) para incluir múltiplos cabeçalhos se necessário.

Parâmetros (Body/Payload)

Define a estrutura de dados enviada (JSON/Form-Data). Mapeie os campos esperados pela API com as variáveis do Edge Protect.

  • Chave (Key): Nome do campo na API (ex: user_login).

Exemplo: user_login

  • Valor (Value): Dado ou variável dinâmica.

Exemplo: ${username}

Tratamento de Resposta (Decode Response)

Define o processamento da resposta recebida antes da validação.

Opções Disponíveis:

Base64: Decodifica respostas em texto plano codificadas em Base64.

Base64 + JSON: Decodifica a string Base64 e interpreta o resultado como um objeto JSON.

Validação e Teste

Área destinada à simulação de login antes da ativação em produção.

Username / Password

Insira credenciais válidas existentes no sistema de destino.

Testar Conexão

Clica em “Testar Conexão” para que o sistema envie a requisição substituindo as tags pelos valores de teste.

Resultado Esperado: Verifique o código HTTP (200 OK) e o corpo da resposta para confirmar o sucesso.

Respondeu à sua pergunta?