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.

Prontos para usar

No topo da tela aparecem os aplicativos que já vêm com as operações configuradas. Neles falta só o acesso à sua instalação.
1

Escolha o aplicativo

Clique em Habilitar no cartão do sistema que você usa.
2

Dê um nome

O nome é o que aparece nos blocos de fluxo. Use algo que diferencie a instalação, como “ERP da matriz”.
3

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.

Cadastrando um aplicativo

Quando o sistema não está no catálogo, use Incluir.
1

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.
2

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.
3

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.
4

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.

A lista

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: 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.

Usando no fluxo

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.

Dúvidas frequentes

É um arquivo que descreve o que a API do outro sistema sabe fazer. Ele lista quais operações existem, que dados cada uma recebe e o que devolve. Quem cuida daquele sistema costuma saber onde ele fica publicado. Sem o contrato, o aplicativo é salvo do mesmo jeito, mas nenhuma operação aparece para escolher no fluxo.
Nos Cabeçalhos padrão do aplicativo, com o valor mascarado na tela. Como a tela guarda credencial, só administradores e responsáveis abrem os Aplicativos.
Não. O bloco Chamada API continua existindo para a chamada avulsa, em que você digita a URL na hora. O aplicativo compensa quando o mesmo sistema é chamado em vários pontos, porque endereço, acesso e operações ficam num lugar só.