Passar para o conteúdo principal
Todas as coleçõesToolzz Connect - TutoriaisPrimeiros passos 🚩
CONFIGURANDO API TOKEN E MÓDULO HTTP - TOOLZZ CONNECT
CONFIGURANDO API TOKEN E MÓDULO HTTP - TOOLZZ CONNECT

Esse é um tutorial da plataforma Toolzz Connect

Atualizado há mais de uma semana

Nesse passo a passo você vai aprender o que é e para que serve um API Token e como configurar um módulo HTTP, que é usado para conectar um serviço da Web ao seu cenário.

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

Vamos usar a plataforma Toolzz LMS como exemplo.

1º passo: você precisa descobrir como ter acesso a chave API do seu aplicativo. No caso do Toolzz LMS encontramos a chave nas configurações de instituição.

2º passo: rmazene o token de API fornecido em um local seguro. Você precisará dele para o seu módulo HTTP para se conectar ao serviço web desejado (Too.zz LMS, neste caso).

A próxima etapa, que vamos te mostrar o passo a passo, é como adicionar o módulo Toolzz Connect's HTTP e fazer as configurações necessárias.

Configurando módulo HTTP

Passo a passo:

1º passo: no menu lateral, acesse a opção "Scenarios".

2º passo: para criar um cenário com um módulo HTTP, clique no botão "+ Create a new scenario".

3º passo: 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.

Clique no botão com o símbolo "+" localizado no centro da página.

4º passo: escolha aplicativo "HTTP".

5º passo: selecione 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.

6º passo: insira a URL da API para a qual você deseja enviar uma solicitação.

7º passo: 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.

8º passo: insira os "Headers" (cabeçalhos) de solicitação desejados. Por exemplo, uma autorização.

⚠️ Cuidado!

Por padrão, a solicitação não contém o header Accept. Se uma resposta inesperada for retornada, tente adicionar o header Accept: */*.

9º passo: insira os pares de valores-chave de consulta desejados.

10º 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.

11º passo: habilite esta opção 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.

12º passo: cliquem em "Show advanced settings" para ver e realizar as configurações avançadas.

13º passo: insira o nome de usuário se desejar enviar uma solicitação usando a autenticação básica.

14º passo: digite a senha se quiser enviar uma solicitação usando a autenticação básica.

15º passo: especifique o tempo limite da solicitação em segundos (1 a 300). Padrão: 40 segundos.

16º passo: ative esta opção para compartilhar cookies do servidor com todos os módulos HTTP em seu cenário.

17º passo: carregue seu certificado se quiser usar o TLS usando seu certificado autoassinado.

18º passo: ative esta opção para rejeitar conexões que usam certificados TLS não verificados.

19º passo: marque a opção "yes" (sim) ou "no" (não) para:

  • Follow redirect: segue os redirecionamentos de URL com respostas 3xx.

  • Follow all redirect: segue os redirecionamentos de URL com todos os códigos de resposta.

20º passo: 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.

21º passo: ative esta opção para solicitar uma versão compactada do site.

Adiciona um header Accept-Encoding para solicitar conteúdo compactado.

Pronto! Você acabou de configurar um módulo de "Fazer um solicitação" de HTTP.

Respondeu à sua pergunta?