ElectroNeek Documentation

API

Atividades do Studio Pro > Programação > API. Inclui "Pedido HTTP" e "Obter token OAuth".


Atividades

Pedido HTTP Obter token OAuth
Envia uma solicitação HTTP com os parâmetros especificados Realiza uma autorização OAuth 2.0

Pedido HTTP

Descrição

Envia uma solicitação HTTP com os parâmetros especificados. O bloco 'Salvar valor em variável' aparece automaticamente ao escolher a atividade 'Pedido HTTP'. Ele salva automaticamente o valor em uma variável. No entanto, o uso do bloco não é obrigatório, e ele pode ser removido do fluxo de trabalho.

Abaixo está um exemplo de como configurar e usar a ação para obter uma lista dos astronautas que estão atualmente em órbita.

Solicitação GET: quantas pessoas estão no espaço agora

Esta API retorna o número atual de pessoas no espaço. Quando conhecidos, ela também retorna os nomes dessas pessoas e as espaçonaves em que estão. Esta API não recebe entradas.

📘Dica

O content-type padrão usado na atividade Pedido HTTP é application/json. Sempre verifique qual content-type é aceito pelo endpoint que você está tentando usar. Se o endpoint exigir um content-type diferente, especifique-o nos cabeçalhos adicionais.

Solicitação

Resposta

{
  "people": [
    {
      "craft": [spacecraft name],
      "name": [name]
    },
    ...
  ],
	"number": [numer of people],
	"message": "success"
}

Parâmetros

URL

Caminho para o recurso web ao qual a solicitação será enviada, por exemplo, http://en.wikipedia.org/w/api.php.

Método

Permite escolher um método de solicitação: "GET", "POST", "PUT", "DELETE" ou "PATCH".

Cabeçalho de autorização

Permite adicionar dados de autorização quando necessário.

Token Bearer

  1. Configurar valor: permite especificar manualmente o token de autenticação.
  2. Calcular valor: permite usar uma fórmula ou um método especial para definir o token de autenticação.
  3. Guardar o resultado do passo anterior: usa o resultado da atividade anterior do fluxo de trabalho como token de autenticação.

Cabeçalhos adicionais

Permite definir cabeçalhos personalizados da solicitação HTTP, por exemplo: {"Content-Type": "application/x-www-form-urlencoded"}.

Parâmetros de consulta

Permite definir os parâmetros de consulta como um objeto.

  1. Guardar o resultado do passo anterior: usa o resultado da atividade anterior como um objeto com parâmetros.
  2. Calcular valor: permite usar as propriedades e os métodos disponíveis para formar um objeto, por exemplo, {action: "opensearch", search: "JavaScript", format: "xml"}.

Parâmetros do corpo

Disponível somente se o método "POST", "PUT", "DELETE" ou "PATCH" estiver selecionado. Contém os parâmetros do corpo como um objeto.

  1. Guardar o resultado do passo anterior: usa o resultado da atividade anterior como um objeto com parâmetros.
  2. Calcular valor: permite usar as propriedades e os métodos disponíveis para formar um objeto, por exemplo: {a:1,b:"row"}.

Enviar ficheiro

Disponível somente quando o método "POST" está selecionado. Este parâmetro permite enviar um arquivo na solicitação.

  1. Configurar valor: permite escrever diretamente o caminho do arquivo a ser enviado. Clicar no botão 'Escolher' permite selecionar o caminho manualmente.
  2. Guardar o resultado do passo anterior: usa o resultado da atividade anterior como caminho.
  3. Calcular valor: permite usar as propriedades e os métodos disponíveis para formar um caminho.

Arquivo do campo de formulário

Este parâmetro contém o nome do campo-chave no corpo da solicitação que contém o caminho do arquivo a ser enviado.

  1. Configurar valor: permite escrever diretamente o nome do campo, por exemplo, file.
  2. Guardar o resultado do passo anterior: usa o resultado da atividade anterior como nome.
  3. Calcular valor: permite usar as propriedades e os métodos disponíveis para formar um nome.

Certificados

Este parâmetro permite anexar um certificado de cliente à solicitação, caso o serviço exija. Para isso, marque a caixa de seleção "Anexar certificado de cliente" e selecione um certificado na lista suspensa. Se você não tiver nenhum certificado adicionado, clique no botão "Adicionar novo certificado". Isso abrirá uma janela pop-up com um formulário para adicionar um certificado. Depois de preencher o formulário, clique em "Adicionar", e a janela será fechada. Você poderá encontrar o certificado adicionado na guia "Certificados" nas configurações do Studio Pro. A mesma configuração pode ser encontrada no Bot Runner.

Comentário

Contém uma anotação para a atividade. O texto inserido será exibido acima do nome da atividade.

Resultado

Por padrão, o resultado da resposta é armazenado na variável http_response. O formato da variável depende do endereço usado na solicitação. Por exemplo, ao usar a API da Wikipedia e enviar uma solicitação com o método 'GET' e os parâmetros {action: "opensearch", search: "JavaScript"}, o seguinte resultado é retornado:

A resposta da API da Wikipedia:

[
  "JavaScript",
  [
    "JavaScript",
    "JavaScript syntax",
    "JavaScript engine",
    "JavaScript library",
    "JavaScript InfoVis Toolkit",
    "JavaScript Style Sheets",
    "JavaScript templating",
    "JavaScriptMVC",
    "JavaScript framework",
    "JavaScript OSA"
  ],
  [
    "JavaScript (), often abbreviated as JS, is a high-level, interpreted scripting language that conforms to the ECMAScript specification.",
    "The syntax of JavaScript is the set of rules that define a correctly structured JavaScript program.",
    "A JavaScript engine is a computer program that executes JavaScript (JS) code. The first JavaScript engines were mere interpreters, but all relevant modern engines utilize just-in-time compilation for improved performance.JavaScript engines are typically developed by web browser vendors, and every major browser has one.",
    "A JavaScript library is a library of pre-written JavaScript which allows for easier development of JavaScript-based applications, especially for AJAX and other web-centric technologies.",
    "The JavaScript InfoVis Toolkit provides tools for creating Interactive Data Visualizations for the Web.",
    "JavaScript Style Sheets (JSSS) was a stylesheet language technology proposed by Netscape Communications Corporation in 1996 to provide facilities for defining the presentation of webpages.",
    "JavaScript templating refers to the client side data binding method implemented with the JavaScript language.",
    "JavaScriptMVC is an open-source rich Internet application framework based on jQuery and OpenAjax. It extends those libraries with a model–view–controller architecture and tools for testing and deployment.",
    "A JavaScript framework is an application framework written in JavaScript. It differs from a JavaScript library in its control flow: A library offers functions to be called by its parent code, whereas a framework defines the entire application design.",
    "JavaScript OSA, (originally JavaScript for OSA, abbreviated as JSOSA), is a freeware inter-process communication scripting language for the Macintosh computer."
  ],
  [
    "https://en.wikipedia.org/wiki/JavaScript",
    "https://en.wikipedia.org/wiki/JavaScript_syntax",
    "https://en.wikipedia.org/wiki/JavaScript_engine",
    "https://en.wikipedia.org/wiki/JavaScript_library",
    "https://en.wikipedia.org/wiki/JavaScript_InfoVis_Toolkit",
    "https://en.wikipedia.org/wiki/JavaScript_Style_Sheets",
    "https://en.wikipedia.org/wiki/JavaScript_templating",
    "https://en.wikipedia.org/wiki/JavaScriptMVC",
    "https://en.wikipedia.org/wiki/JavaScript_framework",
    "https://en.wikipedia.org/wiki/JavaScript_OSA"
  ]
] 

Exemplos de uso

Esta atividade permite interagir com diferentes recursos web, por isso sua gama de usos é bastante ampla. Um exemplo de aplicação desse recurso em um processo robótico é um caso em que você precisa se conectar a uma API web para obter ou enviar dados.


Obter token OAuth

Descrição

Esta atividade realiza uma autorização OAuth 2.0. Retorna um token de acesso para uso em outras atividades.

Parâmetros

URL de autorização

  1. Configurar valor: permite especificar manualmente a URL de autorização.
  2. Calcular valor: permite usar uma fórmula ou um método especial para determinar a URL de autorização.
  3. Guardar o resultado do passo anterior: usa o resultado da ação anterior do fluxo de trabalho como URL de autorização.

Aceder a Token URL

  1. Configurar valor: permite especificar manualmente a Aceder a Token URL.
  2. Calcular valor: permite usar uma fórmula ou um método especial para determinar a Aceder a Token URL.
  3. Guardar o resultado do passo anterior: usa o resultado da ação anterior do fluxo de trabalho como Aceder a Token URL.

ID do cliente

  1. Configurar valor: permite especificar manualmente o ID do cliente.
  2. Calcular valor: permite usar uma fórmula ou um método especial para determinar o ID do cliente.
  3. Guardar o resultado do passo anterior: usa o resultado da ação anterior do fluxo de trabalho como ID do cliente.

Secret do cliente

  1. Configurar valor: permite especificar manualmente o Secret do cliente.
  2. Calcular valor: permite usar uma fórmula ou um método especial para determinar o Secret do cliente.
  3. Guardar o resultado do passo anterior: usa o resultado da ação anterior do fluxo de trabalho como Secret do cliente.

Escopo

  1. Configurar valor: permite especificar manualmente o escopo.
  2. Calcular valor: permite usar uma fórmula ou um método especial para determinar o escopo.
  3. Guardar o resultado do passo anterior: usa o resultado da ação anterior do fluxo de trabalho como escopo.

Estado

  1. Configurar valor: permite especificar manualmente o estado.
  2. Calcular valor: permite usar uma fórmula ou um método especial para determinar o estado.
  3. Guardar o resultado do passo anterior: usa o resultado da ação anterior do fluxo de trabalho como estado.

Uso

Por definição, o protocolo OAuth 2.0 exige a participação humana no processo. O usuário precisa inserir suas credenciais na janela pop-up e permitir que o robô use o serviço.

A maioria dos serviços tem um tempo de vida de token bastante longo: mais de 14 dias. Por isso, é uma boa decisão armazenar o token e solicitar a atenção do usuário somente quando necessário.

Na captura de tela abaixo, você pode ver um exemplo de fluxo de trabalho que solicitará autorização ao usuário somente se o token antigo não for mais válido:

Atualizado