ElectroNeek Documentation

API

Actividades de Studio Pro > Programación > API. Incluye «Consulta HTTP» y «Obtener el token de OAuth».


Actividades

Consulta HTTP Obtener el token de OAuth
Envía una consulta HTTP con los parámetros especificados Realiza una autorización OAuth 2.0

Consulta HTTP

Descripción

Envía una consulta HTTP con los parámetros especificados. El bloque 'Guardar valor en variable' aparece automáticamente al elegir la actividad 'Consulta HTTP'. Guarda automáticamente el valor en una variable. Sin embargo, no es obligatorio usar este bloque y puedes eliminarlo del flujo de trabajo.

A continuación se muestra un ejemplo de cómo configurar y usar la acción para obtener una lista de los astronautas que se encuentran actualmente en órbita.

Solicitud GET: cuántas personas hay en el espacio ahora

Esta API devuelve el número actual de personas en el espacio. Cuando se conocen, también devuelve sus nombres y las naves espaciales en las que se encuentran. Esta API no recibe entradas.

📘Consejo

El content-type predeterminado de la actividad Consulta HTTP es application/json. Verifica siempre qué content-type acepta el endpoint que intentas usar. Si el endpoint requiere un content-type diferente, asegúrate de especificarlo en los encabezados adicionales.

Solicitud

Respuesta

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

Parámetros

URL

Ruta al recurso web al que se enviará la solicitud, por ejemplo, http://en.wikipedia.org/w/api.php.

Método

Permite elegir un método de solicitud: "GET", "POST", "PUT", "DELETE" o "PATCH".

Encabezado de autorización

Permite agregar datos de autorización cuando sea necesario.

Token de portador

  1. Ingresar un valor: permite especificar manualmente el token de autenticación.
  2. Calcular un valor: permite usar una fórmula o un método especial para definir el token de autenticación.
  3. Guardar el resultado del paso anterior: toma el resultado de la actividad anterior del flujo de trabajo como token de autenticación.

Encabezados adicionales

Permite establecer encabezados personalizados para la solicitud HTTP, por ejemplo: {"Content-Type": "application/x-www-form-urlencoded"}.

Parámetros de la consulta

Permite establecer los parámetros de la consulta como un objeto.

  1. Guardar el resultado del paso anterior: elige el resultado de la actividad anterior como objeto con parámetros.
  2. Calcular un valor: permite usar las propiedades y los métodos disponibles para formar un objeto, por ejemplo, {action: "opensearch", search: "JavaScript", format: "xml"}.

Parámetros del cuerpo

Disponible solo si se selecciona el método "POST", "PUT", "DELETE" o "PATCH". Contiene los parámetros del cuerpo como un objeto.

  1. Guardar el resultado del paso anterior: elige el resultado de la actividad anterior como objeto con parámetros.
  2. Calcular un valor: permite usar las propiedades y los métodos disponibles para formar un objeto, por ejemplo: {a:1,b:"row"}.

Enviar archivo

Disponible solo cuando se selecciona el método "POST". Este parámetro permite enviar un archivo en la solicitud.

  1. Ingresar un valor: permite escribir directamente la ruta del archivo que se enviará. Si haces clic en el botón 'Escoger', puedes elegir la ruta manualmente.
  2. Guardar el resultado del paso anterior: elige el resultado de la actividad anterior como ruta.
  3. Calcular un valor: permite usar las propiedades y los métodos disponibles para formar una ruta.

Archivo del campo de formulario

Este parámetro contiene el nombre del campo clave del cuerpo de la solicitud que contiene la ruta del archivo que se enviará.

  1. Ingresar un valor: permite escribir directamente el nombre del campo, por ejemplo, file.
  2. Guardar el resultado del paso anterior: elige el resultado de la actividad anterior como nombre.
  3. Calcular un valor: permite usar las propiedades y los métodos disponibles para formar un nombre.

Certificados

Este parámetro permite adjuntar un certificado de cliente a la solicitud si el servicio lo requiere. Para hacerlo, activa la casilla "Adjuntar un certificado de cliente" y selecciona un certificado de la lista desplegable. Si no has agregado ningún certificado, haz clic en el botón "Añadir nuevo certificado". Se abrirá una ventana emergente con un formulario para agregar un certificado. Una vez completado el formulario, haz clic en "Añadir" y la ventana se cerrará. Podrás encontrar el certificado agregado en la pestaña "Certificados" de la configuración de Studio Pro. La misma configuración está disponible en Bot Runner.

Comentario

Contiene una anotación para la actividad. El texto ingresado se mostrará encima del nombre de la actividad.

Resultado

De forma predeterminada, el resultado de la respuesta se almacena en la variable http_response. El formato de la variable depende de la dirección usada en la solicitud. Por ejemplo, si usas la API de Wikipedia y envías una solicitud con el método 'GET' y los parámetros {action: "opensearch", search: "JavaScript"}, se devuelve el siguiente resultado:

La respuesta de la API de 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"
  ]
] 

Ejemplos de uso

Esta actividad permite interactuar con distintos recursos web, por lo que su campo de aplicación es bastante amplio. Un ejemplo de uso de esta función en un proceso robótico es un caso en el que necesitas conectarte a una API web para obtener o cargar datos.


Obtener el token de OAuth

Descripción

Esta actividad realiza una autorización OAuth 2.0. Devuelve un token de acceso para usar en otras actividades.

Parámetros

URL de autorización

  1. Ingresar un valor: permite especificar manualmente la URL de autorización.
  2. Calcular un valor: permite usar una fórmula o un método especial para determinar la URL de autorización.
  3. Guardar el resultado del paso anterior: toma el resultado de la acción anterior del flujo de trabajo como URL de autorización.

Acceso a la URL del token

  1. Ingresar un valor: permite especificar manualmente el valor de Acceso a la URL del token.
  2. Calcular un valor: permite usar una fórmula o un método especial para determinar el valor de Acceso a la URL del token.
  3. Guardar el resultado del paso anterior: toma el resultado de la acción anterior del flujo de trabajo como valor de Acceso a la URL del token.

ID de cliente

  1. Ingresar un valor: permite especificar manualmente el ID de cliente.
  2. Calcular un valor: permite usar una fórmula o un método especial para determinar el ID de cliente.
  3. Guardar el resultado del paso anterior: toma el resultado de la acción anterior del flujo de trabajo como ID de cliente.

Secreto de cliente

  1. Ingresar un valor: permite especificar manualmente el secreto de cliente.
  2. Calcular un valor: permite usar una fórmula o un método especial para determinar el secreto de cliente.
  3. Guardar el resultado del paso anterior: toma el resultado de la acción anterior del flujo de trabajo como secreto de cliente.

Alcance

  1. Ingresar un valor: permite especificar manualmente el alcance.
  2. Calcular un valor: permite usar una fórmula o un método especial para determinar el alcance.
  3. Guardar el resultado del paso anterior: toma el resultado de la acción anterior del flujo de trabajo como alcance.

Estado

  1. Ingresar un valor: permite especificar manualmente el estado.
  2. Calcular un valor: permite usar una fórmula o un método especial para determinar el estado.
  3. Guardar el resultado del paso anterior: toma el resultado de la acción anterior del flujo de trabajo como estado.

Uso

Por diseño, el protocolo OAuth 2.0 requiere la intervención de una persona. El usuario debe ingresar sus credenciales en la ventana emergente y permitir que el robot use el servicio.

La mayoría de los servicios tienen una vida útil del token bastante larga: más de 14 días. Por lo tanto, es recomendable conservar el token y solicitar la atención del usuario solo cuando sea necesario.

En la siguiente captura de pantalla puedes ver un ejemplo de flujo de trabajo que solicita la autorización del usuario solo si el token anterior ya no es válido:

Actualizado