Todas as coleções
Toolzz Connect - Tutoriais
Conexões
CONECTANDO A SERVIÇOS QUE USAM API TOKEN - TOOLZZ CONNECT
CONECTANDO A SERVIÇOS QUE USAM API TOKEN - TOOLZZ CONNECT

Esse é um tutorial da plataforma Toolzz Connect

Eduardo avatar
Escrito por Eduardo
Atualizado há mais de uma semana

Nesse artigo você encontrará as seguintes informações:

  • Criando um aplicativo e obtendo o token da API

  • Configurando o módulo HTTP


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 ao Toolzz Connect 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:

  • Crie um aplicativo no site do serviço web;

  • Obtenha a chave de API/token de API;

  • Adicione o módulo Toolzz Connect's HTTP > Make an API Key Auth ao seu cenário;

  • Configure o módulo de acordo com a documentação da API do serviço da Web e execute o cenário.


Criando um novo aplicativo e obtendo o token da API

Vamos usar o serviço de notificação “Pushover” como exemplo.

Passo a passo:

1º passo: faça login na sua conta "Pushover".

2º passo: clique em “Create an Application/API Token".

3º passo: preencha as informações do aplicativo e clique em “Create an Application.”

4º passo: armazene o token de API fornecido em um local seguro. Você precisará dele para o seu módulo HTTP > "Make an API Key Auth request" para se conectar ao serviço web desejado (Pushover, neste caso).


Configurar o módulo HTTP

Para conectar um serviço da Web ao seu cenário, você precisa:

  • Adicionar o módulo HTTP > "Make an API Key Auth request" ao seu cenário Toolzz Connect.

  • Configurar o módulo HTTP > "Make an API Key Auth" de acordo com a documentação da API do serviço da Web.

Passo a passo:

1º passo: adicione o módulo HTTP > "Make an API Key Auth" ao seu cenário.

2º passo: no campo “Credentials”, clique em "Add".

3º passo: insira sua Chave de API Pushover no campo "Key".

Você pode clicar no ícone de visibilidade para visualizar sua chave.

4º passo: digite os dados a seguir para integrar sua conta Pushover com o Toolzz connect.

  • O campo URL contém o "endpoint" que você pode encontrar na documentação da API do respectivo serviço da Web.

  • Method: "POST"

    Selecione um método com base no "endpoint" que deseja usar. O "endpoint Pushover" requer o método"POST" para enviar as mensagens.

  • Headers: alguns serviços da web podem usar cabeçalhos para especificar a autenticação do token da API e/ou outros parâmetros. Este não é o caso em nosso exemplo, pois o "endpoint" do Pushover para envio de mensagens usa "Body" para todos os tipos de solicitação.

  • Query String: alguns serviços da web podem usar Query String para especificar outros parâmetros. Este não é o caso em nosso exemplo, pois o serviço da web Pushover usa "Body" para todos os tipos de solicitação.

  • Body Type: "Raw"

    Essa configuração permite que você selecione o tipo de conteúdo JSON no campo “Content Type field below".

  • Content Type: JSON (application/json)

    JSON é o tipo de conteúdo exigido pelo aplicativo Pushover. Isso pode diferir de outros serviços da web.

  • Request Content: insira o conteúdo da solicitação "Body" no formato JSON. Você pode usar o módulo JSON > "Create JSON module" ou inserir o conteúdo JSON manualmente.

Observação:

Essas configurações do módulo correspondem à documentação da API do serviço da web Pushover. As configurações variam entre os serviços da web. Por exemplo, alguns serviços exigem o token de API no cabeçalho e não no campo corpo.

Insira manualmente o corpo da solicitação JSON

Especifique os seguintes parâmetros no formato JSON:

User

A chave de usuário do seu painel Pushover.

Token

O token de API que você gerou seguindo os passos acima.

Menssage

O conteúdo de texto da notificação push enviada para seus dispositivos.

Title

Opcional - O título da mensagem. Se deixado em branco, o nome do seu aplicativo é o título por padrão.

Exemplo:

{ "user" : "12345c2ecu1hq42ypqzhswbyam34" ,

"token" : "123459evz8aepwtxydndydgyumbfx" ,

"message" : "Hello World!" ,

"title" : "A Notificação Push" }

Corpo JSON mapeado usando o módulo JSON > "Create JSON"

O módulo "Create JSON” ajuda você a criar o JSON necessário para o corpo da solicitação. Também oferece a possibilidade de definir valores dinamicamente.

Passo a Passo:

1º passo: insira (ou mapeie) os valores dos quais você deseja criar o JSON.

2º passo: conecte o módulo JSON > "Create JSON" ao HTTP > "Make an API Key Auth Request" que você configurou acima.

3º passo: mapeie a string JSON do módulo "Create JSON" para o campo "Request content" no módulo HTTP > "Make an API Key Auth Request".

Agora, ao executar o cenário, a notificação push é enviada para o dispositivo registrado em sua conta Pushover.

Pronto! Agora você já sabe como conectar o Toolzz Connect com qualquer serviço da Web que use autorização de tokens de API.

Respondeu à sua pergunta?