Frontline Studio · Integrations · Tour interativo

Conectar APIs

Conecte sistemas externos à Frontline com padrões seguros de API e Webhook: payloads explícitos, variáveis, logs, fallbacks e sem credenciais hardcoded.

Tour interativo7 min

API Publica

Use a nova Public API para integracoes profundas.

Use quando um sistema externo precisa criar, ler, coordenar ou reportar recursos da Frontline: agentes, flows/workflows, billing/uso e analitica onde houver suporte.

AgentesWorkflowsAnalyticsBilling/uso

Guia da Academy Abrir docs da API

Fluxo de trabalho builder with routing, Send Message steps, webhook handoff, and Draft or Live controls — Guia de telaIntegrações
Veja Integrações para localizar a ação principal, os dados que a sustentam e o que a equipe deve revisar antes de avançar.

Studio

Conecte esta configuracao a um resultado.

Identifique o que e configurado, que dado entra, que acao produz e onde validar antes de publicar.

Integration catalog showing connectors available when built-in tools are a better fit than a custom API call — Catalogo de integracoesConectores para agentes
Veja Integrações para localizar a ação principal, os dados que a sustentam e o que a equipe deve revisar antes de avançar.

O que você vai construir

Você vai construir um padrão seguro de integração para um workflow chamar um sistema externo ou enviar um Outgoing Webhook, depois verificar a resposta e rotear falhas.

O exemplo deve usar endpoints placeholder e payloads de amostra. Nunca coloque segredos ou URLs privadas em conteúdo público da Academy.

Quando usar

Use API Call ou Outgoing Webhook quando a Frontline precisa de informação de um sistema externo, deve notificar outra ferramenta ou deve entregar um evento estruturado depois de uma decisão de workflow.

Use primeiro CRM, Channels, Tables ou contexto de agente quando eles já fornecem os dados necessários.

API Publica da Frontline

Use a API Publica da Frontline quando uma integracao precisa de acesso programatico a assistentes, flows/workflows, billing/uso ou analitica onde houver suporte.

Esta pagina mantem o padrao operacional em alto nivel. Para endpoints, parametros, autenticacao e exemplos de request, abra a referencia publica Redocly: https://frontline-public-api.redocly.app/api.

Frontline CLI

Se o trabalho de integracao fica no terminal ou em scripts, revise o pacote @getfrontline/cli no npm: https://www.npmjs.com/package/@getfrontline/cli/.

O CLI instala os binarios frontline e max para comandos de Public API, perfis, saida JSON e fluxos do Max.

Como escolher

Use API Call ou Outgoing Webhook quando uma execucao de workflow precisa chamar ou notificar outro sistema.

Use Public API ou CLI quando um sistema externo, script ou developer precisa operar recursos da Frontline fora de uma execucao pontual.

Antes de começar

Confirme owner do sistema externo, endpoint, method, padrão de autenticação, request payload, campos de response, rate limits, timeout e rota de fallback.

Guarde credenciais no mecanismo de segredos ou variáveis aprovado pelo workspace. Exemplos públicos devem usar placeholders como {{apiKey}} ou {{externalRecordId}}.

Implementação passo a passo

Abra Studio e o workflow que precisa da integração.

Adicione ou inspecione um nó API Call ou Outgoing Webhook conforme a direção da integração.

Mapeie variáveis do workflow em campos do request em vez de hardcodear valores específicos de clientes.

Mapeie campos do response para o próximo passo do workflow somente depois de confirmar o formato esperado.

Adicione uma ramificação de falha para timeout, response não 2xx, campo ausente, credencial revogada ou rate limit.

Execute o workflow com um payload de amostra e inspecione Logs antes de habilitar mais tráfego.

Como verificar se funcionou

A execução de amostra deve mostrar request payload, response sanitizado, decisão de ramificação, ação posterior e tratamento de erro em Logs.

Um workflow que depende de uma API não está pronto para lançamento até que a ramificação de falha seja tão clara quanto a de sucesso.

Erros comuns

Não hardcodeie tokens, API keys, bearer strings, IDs de clientes ou URLs privadas em nós de workflow ou exemplos da Academy.

Não assuma que a resposta externa sempre traz o campo que você precisa.

Não pule logs; integrações falham de formas que operadores precisam ver.

Solução de problemas

Se a API Call falha, revise endpoint, method, variável de auth, body do request, timeout e código de response.

Se o próximo nó recebe dados vazios, verifique mapeamento do response e nomes de campos em Logs.

Se retries criam duplicados, adicione idempotency ou lookup antes de ações de escrita.

Fluxos relacionados

Construa um workflow para controlar quando a integração roda e como erros são roteados.

Crie uma tabela quando a integração precisa de dados locais de referência para roteamento ou mapeamento.

Próximo passo claro

Crie uma execução API de amostra com valores placeholder, verifique logs de sucesso e falha, e documente o owner da credencial antes de passar o workflow para Live.

Transcrição

Abrir transcrição pesquisável

Conecte sistemas externos à Frontline com padrões seguros de API e Webhook: payloads explícitos, variáveis, logs, fallbacks e sem credenciais hardcoded. O que você vai construir Você vai construir um padrão seguro de integração para um workflow chamar um sistema externo ou enviar um Outgoing Webhook, depois verificar a resposta e rotear falhas. O exemplo deve usar endpoints placeholder e payloads de amostra. Nunca coloque segredos ou URLs privadas em conteúdo público da Academy. Quando usar Use API Call ou Outgoing Webhook quando a Frontline precisa de informação de um sistema externo, deve notificar outra ferramenta ou deve entregar um evento estruturado depois de uma decisão de workflow. Use primeiro CRM, Channels, Tables ou contexto de agente quando eles já fornecem os dados necessários. Antes de começar Confirme owner do sistema externo, endpoint, method, padrão de autenticação, request payload, campos de response, rate limits, timeout e rota de fallback. Guarde credenciais no mecanismo de segredos ou variáveis aprovado pelo workspace. Exemplos públicos devem usar placeholders como {{apiKey}} ou {{externalRecordId}}. Implementação passo a passo Abra Studio e o workflow que precisa da integração. Adicione ou inspecione um nó API Call ou Outgoing Webhook conforme a direção da integração. Mapeie variáveis do workflow em campos do request em vez de hardcodear valores específicos de clientes. Mapeie campos do response para o próximo passo do workflow somente depois de confirmar o formato esperado. Adicione uma ramificação de falha para timeout, response não 2xx, campo ausente, credencial revogada ou rate limit. Execute o workflow com um payload de amostra e inspecione Logs antes de habilitar mais tráfego. Como verificar se funcionou A execução de amostra deve mostrar request payload, response sanitizado, decisão de ramificação, ação posterior e tratamento de erro em Logs. Um workflow que depende de uma API não está pronto para lançamento até que a ramificação de falha seja tão clara quanto a de sucesso. Erros comuns Não hardcodeie tokens, API keys, bearer strings, IDs de clientes ou URLs privadas em nós de workflow ou exemplos da Academy. Não assuma que a resposta externa sempre traz o campo que você precisa. Não pule logs; integrações falham de formas que operadores precisam ver. Solução de problemas Se a API Call falha, revise endpoint, method, variável de auth, body do request, timeout e código de response. Se o próximo nó recebe dados vazios, verifique mapeamento do response e nomes de campos em Logs. Se retries criam duplicados, adicione idempotency ou lookup antes de ações de escrita. Fluxos relacionados Construa um workflow para controlar quando a integração roda e como erros são roteados. Crie uma tabela quando a integração precisa de dados locais de referência para roteamento ou mapeamento. Próximo passo claro Crie uma execução API de amostra com valores placeholder, verifique logs de sucesso e falha, e documente o owner da credencial antes de passar o workflow para Live.

Perguntas frequentes

Onde as credenciais devem ficar?

Use o mecanismo de segredos ou variáveis aprovado pelo workspace. Não hardcodeie segredos em nós de workflow nem conteúdo da Academy.

Devo publicar URLs privadas na documentação?

Não. Exemplos públicos da Academy devem usar placeholders e descrições sanitizadas de endpoints.

Como torno workflows com API confiáveis?

Valide payloads, mapeie responses explicitamente, adicione ramificações de falha, inspecione logs e evite escritas duplicadas.