gladtolinkblog

Manual de integraciones REST

Jon Cedeño

Jon Cedeño

Share on linkedin
Share on facebook
Share on twitter
Share on google
Share on whatsapp
Cómo configurar una integración a un WebService de tipo REST

Tipo de servicio

En el listado de servicios, debes seleccionar el tipo deseado. En este caso «RESTful».

Configuración del servicio

Selección del nombre

Escogemos un nombre para nuestra nueva integración.

Configuración de la ruta

Esta ruta marcará el punto final de comunicación de nuestra integración (endpoint). La ruta que se especifica aquí será de la cual recibiremos, actualizaremos o introduciremos datos.

Configuración de la llamada

Aquí configuraremos el tipo de llamada. Según la llamada que hagamos a la ruta variará nuestra interacción con los datos.

POST

GET

La llamada POST la utilizaremos si queremos enviar datos al endpoint especificado

La llamada GET la utilizaremos para recoger los datos que deseemos del endpoint especificado.

PUT

PATCH

La llamada PUT la utilizaremos cuando queramos actualizar un dato ubicado en el endpoint.

La llamada PATCH tiene la misma utilidad que PUT, la diferencia es que, mientras que en la llamada PUT se tienen que poner todos los atributos de dicho dato(tanto los modificados como los originales), el PATCH simplemente requiere los atributos que vamos a querer cambiar.

Configuración del envío

En este apartado configuraremos el formato de envío de la llamada.

application/x-www-form-urlencoded

application/json

Los valores son codificados en pares clave-valor, separadas por un & y por un = entre la clave y el valor.

El cuerpo de la llamada se interpretará como un JSON.

application/octet-stream

multipart/form-data

Indica un cuerpo que contiene datos binarios arbitrarios.

Cada valor es enviado como un input de un formulario, con un delimitador como separador definido por el usuario.

RAW/text

El cuerpo de la llamada se interpretará con un texto sin ninguna clase de formato.

Enviar documento

Aquí especificaremos si vamos a querer enviar un documento. En caso afirmativo, hay que especificar el nombre del parámetro del documento.

Tipo de autenticación

Aquí vamos a concretar qué clase de autenticación va a poseer nuestra llamada.

Usuario:Contraseña Base64

Esta clase de autenticación básica consiste en un usuario y contraseña, ambos codificados en base64. En la configuración hay que escribir usuario:contraseña, sin necesidad de codificación.

Token fijo

Esta autenticación consiste en introducir un token fijo, creado de forma externa a la integración.

Bearer Token (OAuth 2.0)

Esta autenticación se basa en una llamada POST o GET a un endpoint, el cual nos proporcionará un campo que contiene un token de acceso, especificado en la sección de token. Los datos necesarios para recibir ese token los tendremos que escribir como parámetros.

Por cookies

La autenticación por cookies funciona similar a la del Bearer. En este caso, el endpoint será una página de login, la cual al loguearnos correctamente nos dará una cookie que autenticará las peticiones de la integración y mantendrá la información de la sesión.

Cabeceras

Las cabeceras nos servirán para enviar o recibir datos adicionales junto a nuestra llamada. Estos se enviarán vía URL junto a la ruta escogida.

Parámetros

Estos parámetros consistirán en el cuerpo de nuestra llamada, y nos serán de utilidad para especificar los datos que queremos manipular.

Respuesta

Finalmente, escogeremos el tipo de respuesta que devuelve el webservice. Podemos especificar que no se nos envíe ninguna clase de respuesta, que la respuesta sea una simple cadena de texto, o incluso podemos especificar un esquema JSON.

En el caso del JSON, habrá que subir un archivo json con el esquema exacto que tendrá la respuesta.

Compártelo
Share on linkedin
Share on facebook
Share on twitter
Share on google
Share on whatsapp

Deja un comentario