Configurar a integração HTTP
Caminho: Opa! Store → Http → Instalar
Visão geral
O app HTTP conecta o Opa! Suite a um sistema externo que tem API, sem precisar de desenvolvimento no Opa! Suite. Você cadastra o endereço do sistema e a forma de autenticação. Depois, usa essa integração no card Requisição HTTP do fluxo de comunicação, para consultar e enviar dados.
Você pode instalar quantas integrações HTTP precisar, uma para cada sistema. O app é gratuito no Opa! Suite.
Pré-requisitos
- Permissão para visualizar o Opa! Store no seu grupo de permissões.
- O endereço (URL) do sistema externo e a forma de autenticação da API dele.
Passo a passo
- Acesse Opa! Store → Http e clique em Instalar. A janela Adicionar app HTTP abre com duas etapas.
- Na etapa Informações principais, preencha:
- Nome: nome para identificar a integração.
- Permitir conexão insegura: ative só se o endereço não tem certificado SSL válido, como um endereço com IP.
- URL: o endereço do sistema externo. Precisa ser uma URL válida.
- Headers: opcional. Os cabeçalhos exigidos pela API em toda requisição, no formato JSON.
- Tempo máximo de resposta do App: opcional. O tempo, em segundos, que o Opa! Suite espera a resposta. O padrão e o mínimo são 30 segundos. Passado o tempo, a conexão é interrompida.
- Clique em Continuar.
- Na etapa Autenticação, em Método de autenticação, escolha uma opção:
- Sem autenticação: a API não pede credenciais.
- Basic: informe Username e Password.
- Token: escolha como o token é obtido. Veja abaixo.
- Clique em Instalar.
Autenticação por token
Em Token, você escolhe entre duas formas:
- Token fixo: deixe Renovar automaticamente desligado e informe o Token. O Opa! Suite envia esse valor como Bearer token em toda requisição. Serve para tokens de longa validade.
- Renovação automática: ative Renovar automaticamente. O Opa! Suite pede um token novo antes de cada requisição. Preencha:
- Método: GET ou POST, conforme a API exige.
- URL token: o endereço que gera o token.
- Username e Password: opcionais, se a API de token pede credenciais.
- Headers, Body e Query params: opcionais, em JSON, com o que a API de token exige.
- Mapeamento do token: o caminho do token na resposta da API (ex.:
data.token).
Com Basic, o Username é obrigatório, e a Password também na instalação. Com token fixo, o Token é obrigatório. Com renovação automática, a URL token e o Mapeamento do token são obrigatórios.
Resultado esperado
A integração aparece na lista do app, com as colunas Nome, Url e Método de autenticação (Sem autenticação, Usuário e senha ou Token). Ela fica disponível para escolher no card Requisição HTTP do fluxo de comunicação. Veja Criar um fluxo de comunicação low code com requisição HTTP.
Configurações disponíveis
Clique na integração para ver as seções Dados de integração e Autenticação. Em cada uma, edite os campos e salve. Para trocar uma senha ou token, digite o novo. Em branco, o atual é mantido.
Para remover, acesse Opa! Store → Http → Acessar, abra o menu de ações da integração e clique em Desinstalar, ou use o botão Desinstalar App dentro dela. O Opa! Suite pede confirmação, porque a conexão é interrompida.
Problemas comuns
| Sintoma | O que verificar |
|---|---|
| Aparece Url inválida | Informe a URL completa, com https://. |
| Aparece JSON inválido | Os Headers (e o Body e Query params da renovação) precisam estar em JSON válido. |
| O tempo máximo é recusado | O tempo mínimo é 30 segundos. |
| A requisição do fluxo falha com a autenticação certa | Se o certificado do sistema externo não é válido, ative Permitir conexão insegura. Com renovação automática, confira a URL token e o Mapeamento do token. |
Boas práticas
- Prefira endereços com HTTPS e certificado válido, e deixe Permitir conexão insegura desligado.
- Mantenha as credenciais e tokens em segurança e atualize-os aqui quando mudarem.
- Crie uma integração por sistema, com um nome fácil de reconhecer.