Visão Geral

O conector API Builder funciona como um gatilho (trigger) de entrada no Ligaí. Ele permite expor um robô ou fluxo de automação como uma API Web (Web-service), gerando uma URL de webhook dedicada.

Toda vez que essa URL gerada receber uma requisição externa, o robô iniciará sua execução automaticamente. Ao concluir todas as etapas do fluxo, o resultado ou resposta final configurada no robô será devolvida diretamente no response da própria URL da chamada HTTP, operando de forma síncrona ou assíncrona conforme o desenho do robô.

Funcionamento de Parâmetros e Variáveis

Você pode customizar a entrada de dados do seu robô enviando informações diretamente pela URL ou pelo corpo da requisição:

  • Query Params e Body: É possível enviar parâmetros de consulta (Query Parameters) anexados na URL ou objetos estruturados dentro do corpo (body) da requisição.

  • Vínculo Dinâmico: Os parâmetros recebidos na URL ou no corpo são automaticamente atrelados a variáveis internas do Ligaí. Essas variáveis servem para alimentar e passar dados dinâmicos para outros conectores subsequentes que estiverem conectados ao nó do API Builder.


Passo a Passo de Configuração


Descrição
No topo do painel da tarefa, o Ligaí exibe os endereços Web exclusivos gerados para o seu robô.

  • Copie e utilize as URLs de exemplo listadas no campo de descrição para realizar as chamadas externas.



1. Definição 
Configure os padrões de protocolo HTTP aceitos pelo gatilho:

  • Verbo HTTP: Escolha o método de requisição aceito no menu suspenso. As opções incluem:

    • GET (Padrão para consultas rápidas ou parâmetros via URL).

    • POST (Recomendado para envio de dados complexos ou arquivos via corpo).

    • PUT, DELETE, PATCH, OPTIONS ou ALL (Para aceitar qualquer método).

  • Content-Type: Defina a estrutura de formatação dos dados que o robô deve processar:

    • JSON (Padrão e mais utilizado para troca de dados estruturados).

    • HTML, TEXT ou XML.



2. Auth 
Defina os critérios de segurança obrigatórios para que sistemas externos consigam disparar o seu robô:

  • Bearer Token: Token alfanumérico de segurança para proteger a chamada contra acessos não autorizados.

  • Autenticação Básica: Tabela para configuração de chaves do tipo Usuário e Senha:

    • Nome: Insira o nome do cabeçalho de usuário.

    • Valor: Informe o token ou valor secreto correspondente. Clique no ícone de mais + para adicionar regras extras.




3. Dados Gerais 
Configure os limites técnicos do ciclo de processamento da chamada:

  • Tempo Máximo de Execução (Timeout): Defina o tempo limite em milissegundos (ex: 1000 equivale a 1 segundo). Ao definir este campo, o valor inserido substituirá o tempo de execução padrão estabelecido pela plataforma.



4. Salvar a Configuração

  • Após o preenchimento dos blocos necessários, clique no botão azul Confirmar na parte inferior da tarefa.

  • Lembre-se de clicar em Salvar na barra superior do robô para gravar as alterações no fluxo de automação.

Domínio Customizado
Caso você tenha configurado seu domínio customizado, ele será refletido em seu endpoint.

Não deixe de consultar o artigo Como configurar um domínio customizado?

Artigos Relacionados

Consulte os artigos para melhor compreensão:

O que é uma API?

Verbos HTTP

Aqui chegamos ao fim de mais um artigo, caso surja mais dúvidas busque por outros artigos em nosso portal de suporte. Caso haja necessidade, envie um e-mail para suporte@ligai.com.br.