API testing

Te enseñaremos el procedimiento a realizar para las pruebas y validaciones de los diferentes endpoint de Manager+.

Actualizado hace más de una semana

En este artículo, te enseñaremos el procedimiento a realizar para las pruebas y validaciones de los diferentes endpoint de Manager+.

Definiciones

Es importante considerar los siguientes puntos:

URL API: https://api.managermas.cl/ o URL que contiene todos los endpoint de Manager+.

POSTMAN: https://www.postman.com/automated-testing o Software que permite efectuar el testing del código en sus diferentes lenguajes.

DOMINIO MANAGER+: https://dominio.managermas.cl/ o URL del ambiente de Manager+.

USER and PASSWORD: Usuario y Contraseña (Credenciales de acceso) de tipo interfaz creados en el dominio de Manager+ que permite la conexión con la API.

En la “URL API” encontrarás los diferentes endpoint de Manager+ donde es importante destacar cinco conceptos para el testing correspondiente:

POST: Corresponde a la dirección URL que permitirá la verificación e inicialización de los componentes de entrada y salida de información, el cual varía dependiendo del Endpoint que corresponda.

URI PARAMETERS: Corresponde a parámetros específicos que componen el POST, determinando algún proceso en específico para el Endpoint en cuestión.

HEADERS: Corresponde al encabezado del testing, son campos específicos que dependen de la API en cuestión y son necesarios para su ejecución.

BODY: Corresponde al cuerpo del testing, básicamente hace referencia al proceso que se está integrando en Manager+ y define los campos a integrar.

TOKEN: Corresponde al valor de referencia que permite el intercambio de información entre Manager+ y el sistema integrado.

Procedimiento

Autenticación

En primer lugar, es necesario obtener el TOKEN de autenticación, el cual permitirá el intercambio de información para los diferentes Endpoint. Para esto, es necesario seguir los siguientes pasos:

En la “URL API” nos dirigimos a la sección “Autenticaciónà Realizar Autenticación” en la modalidad consola, es decir, “Switch Console”.

Obtenemos el POST, especificando el dominio del ambiente del cliente que corresponda.

Ingresamos a “POSTMAN”, indicamos el método POST (cambiar GET por POST) y pegamos el POST del endpoint.

En la “URL API” nos dirigimos a la sección “HEADERS” y copiamos los campos “Content-Type”, su “Valor”.

Luego ingresamos a “POSTMAN” y nos dirigimos a la sección “Headers”, en el campo “Key” indicamos el “Content-Type” y en el campo “Value” su “Valor”.

En la “URL API” nos dirigimos a la sección “BODY” y copiamos el código indicado.

Ingresamos a “POSTMAN” y nos dirigimos a la sección “Body”, opción “Raw” e indicamos el código del punto anterior, específicando el nombre del “username” y su “password”.

Enviamos la información con el botón SEND y obtenemos el TOKEN.

API

Una vez obtenida la autenticación a través del token debemos continuar con la información de la API a integrar, a efectos prácticos de explicación utilizaremos el Endpoint de Documentos. Para esto, es necesario seguir los siguientes pasos:

En la “URL API” nos dirigimos a la sección “Documentos - Crear un Documento” en la modalidad consola, es decir, “Switch Console”.

Nos dirigimos nuevamente al “POSTMAN”, creamos un nuevo request, y pegamos el el POST del endpoint.

Por defecto el Endpoint envía la información en estado “N: Ingresado”. Si es necesario que viaje en estado contabilizado nos dirigimos a la sección “URI PARAMETERS” y copiamos los campos “Variable” y “Valor”.

Ingresamos a “POSTMAN” y nos dirigimos a la sección “Params”, en el campo “Key” indicamos la “Variable” emitir y en el campo “Value” el “Valor”.

En la “URL API’s” nos dirigimos a la sección “HEADERS” y copiamos los campos “Content-Type”, su “Valor” y “Authorization”.

Ingresamos a “POSTMAN” y nos dirigimos a la sección “Headers”, en el campo “Key” indicamos el “Content-Type” y en el campo “Value” su “Valor”. Para la segunda línea, en el campo “Key” indicamos el “Authorization” y en el campo “Value” indicamos lo siguiente: “Token TOKEN OBTENIDO EN EL PROCESO DE AUTORIZACIÓN”.

En la “URL API” nos dirigimos a la sección “BODY” y copiamos el código indicado.

Ingresamos a “POSTMAN” y nos dirigimos a la sección “Body”, opción “Raw” e indicamos el código del punto anterior.

Completamos la información que corresponda según lo parametrizado en el ambiente del cliente. Cabe destacar que en el Json, la variable “rut_empresa:” es el RUT de la empresa que pertenece al dominio y a la cual se le va a enviar la información.

Enviamos la información con el botón SEND y cargamos la información exitosamente.

¿Ha quedado contestada tu pregunta?