Esta etapa permite enviar pedidos HTTP e guardar as suas respostas como variáveis.
Esta etapa está apenas disponível para os planos Business e superiores.
Configuração
Existem duas definições principais na Etapa de Solicitação HTTP:
Método de pedido HTTP
O método específico necessário para o pedido. Escolha o método adequado na lista pendente.
URL
No campo URL, introduza o ponto final do URL da API externa para recuperar dados. Para incluir variáveis, utilize o prefixo "$" para suportar a interpolação de texto estático e variáveis.
Agora pode utilizar endereços IP e números de porta na etapa de pedido HTTP, o que lhe dá acesso direto aos servidores e flexibilidade para aceder a serviços em portas não padrão.
Note que tanto o respond.io como os domínios de marca branca estão na lista negra. Não é permitido enviar uma chamada API para estes domínios, pois pode causar problemas de loop.
Corpo
Para garantir a descodificação correta pelo destinatário do pedido, expanda a secção Corpo e inclua um corpo juntamente com o Cabeçalho do Tipo de Conteúdo.
Cabeçalhos
Na secção Cabeçalho, pode adicionar cabeçalhos ao pedido HTTP em pares. A chave representa o nome do cabeçalho e o valor representa o valor do cabeçalho. Pode utilizar variáveis como cabeçalhos, adicionando o prefixo "$". No entanto, lembre-se que apenas são permitidos 10 cabeçalhos.
Mapeamento de Resposta
Para respostas da API JSON com pares chave-valor, pode guardar elementos de resposta específicos como Variáveis. Na secção Mapeamento de Resposta, introduza a chave do objeto JSON à esquerda e atribua um nome à variável à direita. Lembre-se de que apenas as respostas JSON podem ser guardadas e pode ter um máximo de 10 definições de mapeamento de respostas.
Exemplos:
Para guardar uma resposta em diferentes formatos, preencha a chave JSON correspondente aos dados que pretende guardar.
{
"nome": "Jason",
"códigos_postais": "12345",
"telefone": "123123"
}Para guardar o número de telefone da resposta acima, utilize $. phone como chave JSON.
{
"campos_personalizados": {
"primeiroNome": "João",
"sobrenome": "Doe",
"localidade": "en_GB",
"fuso_horário": "5",
"sexo": "masculino",
"telefone": "123123",
"email": "zy@respond.io",
"customerid": "1"
},
"criado_em": 1575618542
}Para guardar o número de telefone da resposta acima, utilize $.custom_fields.phone
{
"dados": {
"id":"1776025372480910",
"contatos": [
{
"primeiroNome":"João",
"sobrenome":"Doe",
"localidade": "en_GB"
},
{
"primeiroNome":"Jane",
"sobrenome":"Doe",
"localidade": "en_GB"
}
]
}
}Para guardar o primeiro nome 'Jane' da resposta acima, utilize $.data.contacts[1].firstName.
Guardar o estado de resposta como variável
Para guardar o estado da resposta do pedido HTTP como uma variável, ative a opção Guardar o estado da resposta como variável . Em seguida, nomeie a variável no campo fornecido.
Como funciona
Quando ativada, esta etapa enviará um pedido HTTP para o URL especificado, utilizando o corpo e o cabeçalho definidos.
Pode orientar o fluxo de trabalho com base no estado da resposta. Por exemplo, pode criar uma ramificação para "o código de estado é igual a 200". Se qualquer outro código de status de resposta for recebido, um Passo de Salto pode devolver Contatos à Etapa de Requisição HTTP. Alternativamente, o contato pode ser direcionado para o Ramo de Falha se as condições do ramo não forem atendidas. Se não existirem passos configurados no Ramo de Falha, o Fluxo de Trabalho será concluído.
Se o seu pedido HTTP exceder 10 segundos, ocorrerá um tempo limite, causando a falha do pedido.
Falha potencial
Para evitar possíveis falhas na execução de pedidos HTTP, certifique-se de que as seguintes condições são cumpridas:
Utilize o método HTTP correto e o cabeçalho Content-Type.
Certifique-se de que inclui o protocolo necessário
http://ouhttps://no seu URL com base no que o seu sistema suporta para evitar falhas de pedido.Certifique-se de que o Content-Type é válido.
Exclua o número da porta da URL.
Evite utilizar um certificado autoassinado no URL.
Verifique se a autorização é válida.
Certifique-se de que os nossos endereços IP (52.74.35.155, 18.138.31.163, 54.169.155.20) não estão bloqueados.
Se alguma das condições acima não for cumprida, o contato pulará esta etapa e prosseguirá com a jornada restante.
Ao verificar as saídas de pedidos HTTP com variáveis dinâmicas, lembre-se que as variáveis sem valor retornarão como null e undefined.
Melhores Práticas
Aqui estão algumas práticas recomendadas para esta etapa que pode seguir para otimizar o seu fluxo de trabalho:
Quando a solicitação HTTP for bem-sucedida.
Guardar o estado de resposta como uma variável:
Certifique-se de que o primeiro passo é guardar o Estado de Resposta como Variável para ações futuras.
Etapa de ramificação:
Adicione uma etapa de ramificação para avaliar o estado do pedido HTTP.
Se o estado for
200, o pedido foi bem-sucedido.Caso contrário, configure um alerta para notificar o gestor sobre o pedido mal sucedido.
Folha de Cálculo Google para Monitorização:
Registe o estado da resposta numa folha de cálculo do Google para ter uma visibilidade clara sobre o sucesso ou insucesso das solicitações.
Comentar:
Adicione um comentário no seu fluxo de trabalho para documentar o Estado da Resposta. Isso irá ajudá-lo a rastrear e rever erros com mais eficiência.
Quando a solicitação HTTP falha
Guardar o estado de resposta como uma variável:
Semelhante ao pedido bem-sucedido, guarda o Estado de Resposta como Variável para tratamento de erros.
Usa Wait ou Jump Step para novas tentativas:
Implemente a Etapa de Espera para pausar antes de tentar novamente um pedido mal sucedido.
Em alternativa, utilize a Etapa de salto para voltar à Etapa de pedido HTTP e tentar o pedido novamente.
Comentário:
Documente o erro criando um comentário para registar o erro de pedido HTTP
Inclua os dados de contacto e marque a pessoa responsável.
Folha de Cálculo Google para Monitorização:
Utilize a Folha de Cálculo Google para registar as informações de contacto e os detalhes do erro para monitorização e revisão.
Atribuição de tarefa:
Atribua a tarefa a um utilizador específico para iniciar outro processo dentro do fluxo de trabalho e tente novamente.
Casos de uso sugeridos
Aqui estão algumas formas de utilizar a Etapa de Solicitação HTTP:
Encaminhar contactos VIP: Utilize o passo de pedido HTTP para pesquisar os dados de contacto de um data warehouse como um CRM. Isto permite identificar os contactos VIP, permitindo uma experiência personalizada ao cliente e distinguindo-os dos contactos não VIP.