Aplicativos
Cadastre os sistemas que os fluxos chamam por HTTP, com endereço, acesso e contrato guardados num lugar só
Cadastre os sistemas que os fluxos chamam por HTTP, com endereço, acesso e contrato guardados num lugar só
Um aplicativo é o cadastro de um sistema externo que os seus fluxos podem chamar. Pode ser o ERP da empresa, um sistema de cobrança ou uma API que a sua equipe mantém. Você informa uma vez o endereço, o acesso e a lista de operações. Depois disso, quem monta o fluxo escolhe a operação pelo nome, sem colar URL nem chave de API em cada bloco.
Os aplicativos ficam em Configurações > Integrações > Aplicativos. A tela é liberada para administradores e responsáveis, porque é ali que ficam guardadas as credenciais de acesso aos outros sistemas.
No topo da tela aparecem os aplicativos que já vêm com as operações configuradas. Neles falta só o acesso à sua instalação.
Escolha o aplicativo
Clique em Habilitar no cartão do sistema que você usa.
Dê um nome
O nome é o que aparece nos blocos de fluxo. Use algo que diferencie a instalação, como "ERP da matriz".
Informe o acesso
Confirme o Endereço base e preencha os campos de acesso que o cartão pedir, como chave de API ou usuário. Clique em Habilitar.
Dá para habilitar o mesmo aplicativo mais de uma vez, uma para cada instalação. O cartão passa a mostrar Habilitar outro depois da primeira.
Quando o sistema não está no catálogo, use Incluir.
Preencha as informações gerais
Nome e Endereço base são obrigatórios. O endereço base é o começo da URL de toda chamada, e o caminho de cada operação vem do contrato. A Descrição ajuda quem for montar o fluxo depois. O botão Ativo controla se o aplicativo aparece para os blocos.
Importe o contrato
Clique em Importar contrato. Escolha Arquivo, para enviar o .json, .yaml ou .yml do contrato OpenAPI, ou Endereço, para informar a URL onde o contrato está publicado. É o contrato que traz o nome e a descrição de cada operação.
Adicione os cabeçalhos padrão
Em Cabeçalhos, informe o que precisa ir em toda chamada, como chave de API ou identificação de ambiente. O valor fica mascarado, e o ícone de olho mostra o conteúdo.
Salve
Clique em Salvar. O aplicativo entra na lista e já pode ser escolhido nos fluxos.
Cabeçalho definido no bloco do fluxo tem prioridade sobre o cabeçalho de mesma chave definido no aplicativo.
Cada linha mostra o nome, o Endereço base, a Descrição, a Versão do contrato e o Status, que diz se o aplicativo está ativo. O menu da linha tem três ações:
| Ação | O que faz |
|---|---|
| Editar | Abre o cadastro para trocar endereço, cabeçalho ou contrato |
| Conferir contrato | Busca o contrato de novo e atualiza a lista de operações |
| Excluir | Remove o aplicativo da conta |
Use Conferir contrato quando o sistema externo ganhar uma operação nova ou mudar um parâmetro. Nos aplicativos vindos do catálogo, essa conferência acontece sozinha todo dia.
Excluir um aplicativo derruba os blocos de fluxo que dependem dele. Confira em quais fluxos ele é usado antes de confirmar.
Com o aplicativo cadastrado, o editor de fluxos ganha o bloco Aplicativo, onde você escolhe o aplicativo, a operação e preenche os parâmetros. Veja em Fluxos.