Conectividad: REST

Visión General

La conectividad REST puede utilizarse con servicios web que trabajen con APIs REST, tales como SAP Business One, Zoho CRM, iugu y Google Fit.

Si el sistema ya cuenta con una API, Skyone Studio puede consumirla directamente, añadiendo controles de rate limit y seguridad, lo que facilita su integración con otros productos.

Skyone Studio trabaja con el formato JSON, permitiendo los siguientes métodos de solicitud HTTP:

POST
GET
UPDATE
DELETE
PATCH

Tipos de Autenticación

Al elegir la conectividad REST, tendrás disponibles las siguientes opciones:

No Auth: conexión abierta, sin autenticación.
Basic: autenticación simple con usuario y contraseña.
Bearer Token: requiere un token en formato JWT u otro definido.
OAuth 1: autenticación en el estándar OAuth 1.0.
OAuth 2: autenticación en el estándar OAuth 2.0.
Cookie: autenticación por medio de cookies para solicitudes de clientes y manejo de sesiones.
AWS: autenticación HMAC, utilizada para acceder a servicios de AWS.
OAuth2 JWT: autenticación en el estándar OAuth 2.0 con uso de JWT.
Header Authentication: autenticación mediante información en los headers de la solicitud.
Certificado CA: utiliza certificados digitales emitidos por una Autoridad Certificadora (CA) para validar la identidad y garantizar seguridad.
mTLS: autenticación mutua TLS, donde tanto cliente como servidor presentan certificados válidos para establecer una comunicación segura.

Cómo conectar una cuenta

Después de definir el tipo de conectividad, el siguiente paso es seleccionar el tipo de autenticación. Solo después de esta definición podrás:

Agregar una nueva cuenta.
Seleccionar, editar o eliminar cuentas previamente registradas.

Para añadir una cuenta conectada:

Haz clic en “Cuenta conectada”.
Luego, selecciona “Agregar cuenta conectada”.

A continuación, continúa con la configuración accediendo a la pestaña del tipo de autenticación elegido.

Importante: presta atención al campo “Host” en la configuración de la cuenta conectada, ya que los datos allí definidos se concatenarán con las configuraciones de las operaciones.

Sin Autenticación

Al elegir la opción “Agregar cuenta conectada”, se mostrará el siguiente modal:

Completa los campos de la siguiente manera:

Terminal (opcional): si tienes un terminal configurado, selecciónalo para que la conexión se realice a través del Agente correspondiente.
Nombre de la cuenta: nombre asignado a la cuenta registrada.
Host: dirección IP de la API.
Puerto: número del puerto de la API.

Una vez completados los datos, haz clic en “Crear cuenta”.

¡Listo! Tu cuenta conectada ha sido creada y podrá utilizarse en otros módulos y flujos, apareciendo entre las opciones de cuentas configuradas en ambos casos.

Basic

Al elegir la opción “Agregar cuenta conectada”, se mostrará el siguiente modal:

Completa los campos de la siguiente manera:

Terminal (opcional): si tienes un terminal configurado, selecciónalo para que la conexión se realice a través del Agente correspondiente.
Nombre de la cuenta: nombre asignado a la cuenta registrada.
Host: dirección IP de la API.
Puerto: número del puerto de la API.
Usuario
Contraseña

Una vez completados los datos, haz clic en “Crear cuenta”.

¡Listo! Tu cuenta conectada ha sido creada y podrá utilizarse en otros módulos y flujos, apareciendo entre las opciones de cuentas configuradas en ambos casos.

Token Bearer

Al elegir la opción “Agregar cuenta conectada”, se mostrará el siguiente modal:

Completa los campos de la siguiente manera:

Terminal (opcional): si tienes un terminal configurado, selecciónalo para que la conexión se realice a través del Agente correspondiente.
Nombre de la cuenta: nombre asignado a la cuenta registrada.
Host: dirección IP de la API.
Puerto: número del puerto de la API.
Token: token previamente creado.

Una vez completados los datos, haz clic en “Crear cuenta”.

¡Listo! Tu cuenta conectada ha sido creada y podrá utilizarse en otros módulos y flujos, apareciendo entre las opciones de cuentas configuradas en ambos casos.

OAuth 1

Al elegir la opción “Agregar cuenta conectada”, se mostrará el siguiente modal:

Completa los campos de la siguiente manera:

Terminal (opcional): si tienes un terminal configurado, selecciónalo para que la conexión se realice a través del Agente correspondiente.
Nombre de la cuenta: nombre asignado a la cuenta registrada.
Host: dirección IP de la API.
Puerto: número del puerto de la API.
Customer Key: usuario requerido para la autenticación.
Customer Secret: contraseña necesaria para la autenticación.
Access token: token utilizado para acceder a la API.
Token secret: token obtenido para conceder un nuevo access token sin que el usuario necesite iniciar sesión nuevamente.
Método de firma: técnica de seguridad que utiliza HMAC-SHA1 para garantizar la autenticidad.

Una vez completados los datos, haz clic en “Crear cuenta”.

¡Listo! Tu cuenta conectada ha sido creada y podrá utilizarse en otros módulos y flujos, apareciendo entre las opciones de cuentas configuradas en ambos casos.

OAuth 2

Al elegir la opción “Agregar cuenta conectada”, se mostrará el siguiente modal:

Completa los campos de la siguiente manera:

Nombre de la cuenta: nombre asignado a la cuenta registrada.
Host: dirección IP de la API.
Puerto: número del puerto de la API.
Client ID: usuario necesario para la autenticación.
Client Secret: contraseña necesaria para la autenticación.
Access token: token utilizado para acceder a la API.
Refresh token: token obtenido para conceder un nuevo access token sin que el usuario necesite iniciar sesión nuevamente.
Endpoint de intercambio de token: URL utilizada para obtener tokens para autorizar usuarios.
Content type: formato de datos que se transmitirá en la solicitud. Por defecto es JSON, pero puede cambiarse a URL Encoded.

Parámetros del payload del token:

Clave: identificador o nombre asociado a una información específica del payload del token.
Valor: dato asociado a la clave, contextualizando la información de autenticación ingresada previamente.
Clave de la respuesta con el token: clave del JSON que retornará la información del token en el body. Por defecto es Access Token, pero si es otro (por ejemplo, Zoho Token), debe especificarse.
Clave de la respuesta con el refresh token: clave del JSON que retornará la información del Refresh Token en el body.
Enviar parámetros de intercambio de token como query string: si se selecciona, los parámetros del Refresh Token se enviarán como query string.

Parámetros en el header de la solicitud después de la autenticación:

Clave: nombre del parámetro que se enviará en la llamada GET a un Resource Server, por ejemplo: Authorization.
Valor: dato necesario para transmitir o autenticar el acceso, por ejemplo: Bearer <token>.

Una vez completados los datos, haz clic en “Crear cuenta”.

¡Listo! Tu cuenta conectada ha sido creada y podrá utilizarse en otros módulos y flujos, apareciendo entre las opciones de cuentas configuradas en ambos casos.

AWS

Al elegir la opción “Agregar cuenta conectada”, se mostrará el siguiente modal:

Completa los campos de la siguiente manera:

Nombre de la cuenta: nombre asignado a la cuenta registrada.
Host: dirección IP de la API.
Puerto: número del puerto de la API.
AWS Access Key ID: usuario de la cuenta AWS.
AWS Secret Access Key: contraseña de la cuenta AWS.
Servicio AWS: servicio de AWS que se desea utilizar, por ejemplo: s3, ses, ecs2.
Región AWS: región según la nomenclatura de AWS, por ejemplo: us-east-1, ap-southeast-1.

Una vez completados los datos, haz clic en “Crear cuenta”.

¡Listo! Tu cuenta conectada ha sido creada y podrá utilizarse en otros módulos y flujos, apareciendo entre las opciones de cuentas configuradas en ambos casos.

OAuth2 JWT

Al elegir la opción “Agregar cuenta conectada”, se mostrará el siguiente modal:

Completa los campos de la siguiente manera:

Nombre de la cuenta: nombre asignado a la cuenta registrada.
Host: dirección IP de la API.
Puerto (opcional): número del puerto de la API.
Private Key: carga un archivo de clave privada (.pem).
URL de autenticación: URL para solicitar el token de autenticación.
Tiempo de expiración JWT (s): tiempo antes de que el token JWT expire, en segundos.
Content type: formato de datos que se transmitirá en la solicitud; por defecto es JSON, pero puede cambiarse a URL Encoded.

Parámetros en el payload JWT (campos Clave y Valor):

iss (issuer): emisor del token.
aud (audience): destinatario del token, representa la aplicación que lo usará.
scope: alcance de los datos solicitados.

Parámetros en el cuerpo de la solicitud del token (campos Clave y Valor):

authorization: valor del token de autorización.
Clave de la respuesta: token.

Parámetros en el header de la solicitud después de la autenticación (campos Clave y Valor):

authorization: valor del token de autorización.

Una vez completados los datos, haz clic en “Crear cuenta”.

¡Listo! Tu cuenta conectada ha sido creada y podrá utilizarse en otros módulos y flujos, apareciendo entre las opciones de cuentas configuradas en ambos casos.

Autenticación por encabezado

Al elegir la opción “Agregar cuenta conectada”, se mostrará el siguiente modal:

Completa los campos de la siguiente manera:

Nombre de la cuenta: nombre asignado a la cuenta registrada.
Host: dirección IP de la API.
Puerto (opcional): número del puerto de la API.

Opciones del header:

Clave: nombre del parámetro que se enviará.
Valor: dato asociado necesario para transmitir o autenticar el acceso.

Una vez completados los datos, haz clic en “Crear cuenta”.

¡Listo! Tu cuenta conectada ha sido creada y podrá utilizarse en otros módulos y flujos, apareciendo entre las opciones de cuentas configuradas en ambos casos.

Certificado CA

Al elegir la opción “Agregar cuenta conectada”, se mostrará el siguiente modal:

Completa los campos de la siguiente manera:

Nombre de la cuenta: nombre asignado a la cuenta registrada.
Host: dirección IP de la API.
Puerto (opcional): número del puerto de la API.
Agregar el Certificado CA

Una vez completados los datos, haz clic en “Crear cuenta”.

¡Listo! Tu cuenta conectada ha sido creada y podrá utilizarse en otros módulos y flujos, apareciendo entre las opciones de cuentas configuradas en ambos casos.

mTLS

Al elegir la opción “Agregar cuenta conectada”, se mostrará el siguiente modal:

Completa los campos de la siguiente manera:

Nombre de la cuenta: nombre asignado a la cuenta registrada.
Host: dirección IP de la API.
Puerto: número del puerto de la API.
Certificado del cliente: carga del certificado del cliente, firmado por la CA (archivo .crt).
Clave privada del cliente: carga de la clave privada correspondiente al certificado del cliente (archivo .key).
Certificado intermedio: carga del certificado de la CA raíz o intermedia que firmó el certificado del servidor (archivo .crt).

Una vez completados los datos, haz clic en “Crear cuenta”.

¡Listo! Tu cuenta conectada ha sido creada y podrá utilizarse en otros módulos y flujos, apareciendo entre las opciones de cuentas configuradas en ambos casos.

Para finalizar, haz clic en “Guardar cambios” para definir las configuraciones de tu módulo.

Importante: después de guardar los cambios, ya no será posible modificar el Tipo de conectividad y/o el Tipo de autenticación.

Siguiente paso: Crea operaciones para el módulo.

También puedes consultar:

PreviousConectividade: Email NextConectividad: SOAP

Last updated 1 month ago