O bloco de API permite que sua jornada se comunique com sistemas externos por meio de chamadas HTTP. É ideal para enviar dados, obter informações ou integrar com serviços terceiros durante o fluxo.
1. Acesso ao Bloco de API
Ao clicar no bloco adicionado à jornada, o painel de configuração será exibido à direita da tela.
2. Configuração do Bloco de API
2.1 – Informações Básicas
- Nome do Bloco: Clique sobre o nome para editá-lo.
- ID do Bloco: Identificador técnico interno, usado apenas para suporte.
- TAGs: Categorizam e segmentam informações nos relatórios. Devem ser cadastradas previamente.
3. Parâmetros da Requisição
3.1 – URL
- Informe o endpoint da API.
- Pode conter variáveis dinâmicas acessíveis pelo menu {}.
3.2 – Método HTTP
- Escolha entre: GET, POST, PUT, DELETE.
3.3 – Body da Requisição
- Campo para o corpo do request (usualmente em JSON).
- É possível inserir variáveis para enviar dados personalizados.
3.4 – Headers
- Clique em Adicionar campo ao cabeçalho para incluir pares chave:valor.
- Pode adicionar múltiplos headers conforme necessidade (ex: autenticação, content-type).
4. Comportamento da Requisição
4.1 – Tempo de Espera
- Define o tempo máximo que o sistema aguardará a resposta da API. (A definir tecnicamente)
4.2 – Aguardar Resposta
- Se habilitado:
- O fluxo aguarda o retorno da API antes de continuar.
- Em caso de erro, é possível definir:
- Quantidade de tentativas de reenvio
- Timeout personalizado
5. Captura de Respostas da API
5.1 – Atualizar Variável
- Permite armazenar valores da resposta da API em variáveis do fluxo.
- Informe:
- Variável que será preenchida
- Campo do JSON de retorno que será lido (ex: data.status, user.id)
Essa funcionalidade permite que as informações recebidas influenciem blocos posteriores como Condicionais e Mensagens Personalizadas.