Sobre
Existem alguns serviços que não permitem que o Toolzz Connect (e outras plataformas de integração) criem um aplicativo que você possa usar facilmente em seu cenário.
Felizmente, há uma solução alternativa. Você pode conectar o serviço (aplicativo) desejado usando o módulo HTTP do Toolzz Connect.
Como funciona
Como na maioria dos serviços da web, o procedimento de conexão do serviço por meio de um token de API é semelhante e consiste nas seguintes etapas:
Criar um aplicativo no site do serviço web;
Obter a chave de API/token de API;
Obtendo o token da API de um aplicativo
Para conectar um aplicativo ao Toolzz Connect usando o módulo HTTP, você precisará da chave ou token de API do aplicativo.
Cada app tem um processo diferente para obter essa chave, mas geralmente ela pode ser encontrada na seção de configurações da conta, em áreas como "API", "Integrações" ou "Desenvolvedores". Consulte a documentação do aplicativo específico para saber os passos detalhados de como gerar ou localizar essa chave.
Após obter a chave/token de API, a próxima etapa será a de adicionar o módulo de HTTP do Toolzz Connect e fazer as configurações necessárias.
Configurando módulo HTTP
1º passo: no menu lateral, acesse a opção "Scenarios" e depois clique no botão "+ Create a new scenario".
O aplicativo HTTP fornece vários módulos para comunicação baseados em Hypertext Transfer Protocol (HTTP ).
HTTP é a base da comunicação de dados para a World Wide Web. Os módulos permitem que você baixe páginas e arquivos da Web, chame webhooks e endpoints de API, etc.
2º passo: clique no botão com o símbolo "+" localizado no centro da página. Procure e selecione o aplicativo "HTTP" e depois escolha o módulo "Make a request".
O módulo HTTP "Make a request", é um módulo universal que permite configurar uma solicitação HTTP e enviá-la a um servidor. A resposta HTTP recebida é então contida no pacote de saída.
3º passo: no campo "URL" insira a URL da API para a qual você deseja enviar uma solicitação.
No campo "Method" selecione o método HTTP que deseja usar:
GET - para recuperar informações para uma entrada.
POST - para criar uma entrada.
PUT - para atualizar/substituir uma entrada existente.
PATCH - para fazer uma atualização parcial da entrada.
DELETE - para excluir uma entrada.
4º passo: insira os "Headers" (cabeçalhos) de solicitação desejados. Por exemplo, uma autorização.
Name: Authorization.
Value: "Bearer" e a chave/token de API do aplicativo.
🚨Atenção!
Neste exemplo, o tipo de token é Bearer, mas pode variar dependendo do aplicativo.
Algumas APIs de apps exigem cabeçalhos adicionais. Consulte a documentação da API do app para saber mais sobre o tipo de token e cabeçalhos.
5º passo: no campo "Query String", você coloca pares de chave-valor que serão enviados na URL como parâmetros adicionais para a solicitação HTTP.
6º passo: body type HTTP são os bytes de dados transmitidos em uma mensagem de transação HTTP imediatamente após os cabeçalhos, se houver algum a ser usado.
Raw
É adequado para a maioria das solicitações, mesmo em situações em que a documentação do desenvolvedor não especifica os dados a serem enviados. Especifique uma forma de análise dos dados no campo "Content type". Apesar do tipo de conteúdo selecionado, os dados são inseridos em qualquer formato estipulado ou exigido pela documentação do desenvolvedor.
Application/x-www-form-urlencoded
É para postar dados usando application/x-www-form-urlencoded.
O corpo da mensagem HTTP enviada ao servidor é, essencialmente, uma string de consulta. As chaves e os valores são codificados em pares separados por &
e um =
entre a chave e o valor. Não é adequado para uso com dados binários (use multipart/form-data
em vez disso).
Multipart/form-data
Usada para enviar arquivos e dados e fazer upload de arquivos para o servidor. Adicione campos a serem enviados na solicitação. Cada campo deve conter o par Chave-Valor. Text: insira a chave e o valor a serem enviados no corpo da solicitação.
File: insira a chave e especifique o arquivo de origem que deseja enviar no corpo da solicitação. Mapeie o arquivo que você deseja carregar do módulo anterior ou insira o nome e os dados do arquivo manualmente.
7º passo: habilite a opção "Parse response" para analisar respostas automaticamente e converter respostas JSON e XML para que você não precise usar módulos JSON > Parse JSON or XML > Parse XML.
Antes de poder usar o conteúdo JSON ou XML analisado, execute o módulo uma vez manualmente para o módulo poder reconhecer o conteúdo da resposta e permitir que você o mapeie nos módulos subsequentes.
8º passo: clique em "Show advanced settings" para ver e realizar as configurações avançadas.
User name: digite o nome de usuário para enviar a solicitação com autenticação básica;
Password: digite a senha para enviar a solicitação com autenticação básica;
Timeout: especifique o tempo limite da solicitação em segundos (1-300). Padrão: 40 segundos;
Share cookies with other HTTP modules: ative para compartilhar cookies do servidor com todos os módulos HTTP no seu cenário;
Self-signed certificate: envie seu certificado se quiser usar TLS com um certificado autoassinado;
Reject connections that are using unverified (self-signed): ative para rejeitar conexões que usam certificados TLS não verificado;
Follow redirect: ative para seguir redirecionamentos de URL que retornam status de resposta 3xx;
Follow all redirect: ative para seguir redirecionamentos de URL, independentemente dos status de resposta;
Disable serialization of multiple same query string keys as arrays: por padrão, o Toolzz Connect lida com vários valores para a mesma chave de parâmetro de string de consulta de URL como matrizes. Para desativar este recurso, ative esta opção;
Request compressed content: ative para solicitar a compressão dos dados de resposta. Isso adiciona o cabeçalho Accept-Encoding.
Pronto! Agora você já sabe como usar um módulo de HTTP para conectar a um aplicativo através de API.