¿Cómo probar la API de Magento 2 con Postman? [Backend]

Ya te hemos publicado sobre cómo empezar a trabajar con la API en Magento 2 y las actualizaciones de la API de Magento 2.3 .

Ahora es el momento de pasar a otra pregunta crítica sobre la API en Magento: las pruebas.

OBTENGA UNA GUÍA GRATUITA SOBRE:
– TIPOS DE USUARIOS DE LA API M2 Y CÓMO CREAR UNA NUEVA INTEGRACIÓN – TIPOS DE
AUTENTICACIÓN DE LA API M2

(function() {
if (!window.mc4wp) {
window.mc4wp = {
listeners: [],
forms : {
on: function (event, callback) {
window.mc4wp.listeners.push({
event : event,
callback: callback
});
}
}
}
}
})();

(function() {
mc4wp.forms.on(‘27330.submit’, function(form, event) {
event.preventDefault();

var submitForm = function() {
if(form.element.className.indexOf(‘mc4wp-ajax’) > -1) {
mc4wp.forms.trigger(‘submit’, [form, event]);
} else {
form.element.submit();
}
};
var previousToken = form.element.querySelector(‘input[name=_mc4wp_grecaptcha_token]’);
if (previousToken) {
previousToken.parentElement.removeChild(previousToken);
}

try {
window.grecaptcha
.execute(‘6LcoY6UZAAAAAP7Dqjtr6MPM8yGySn617oAlWVSx’, {action: ‘mc4wp_form_submit’})
.then(function (token) {
var tokenEl = document.createElement(‘input’);
tokenEl.type = ‘hidden’;
tokenEl.value = token;
tokenEl.name = ‘_mc4wp_grecaptcha_token’;
form.element.appendChild(tokenEl);
submitForm();
});
} catch(err) {
submitForm();
throw err;
}
})
})();

Deja este campo vacío si eres humano:

Entonces, ¿cómo probar la API de manera eficiente? Existe una gama de herramientas que facilitan las pruebas y las hacen más rápidas, y probamos una de ellas. Satisfechos con los resultados, estamos listos para compartir nuestra experiencia.

¡Así que conoce a Postman!

Probando la API de Magento 2: ¿qué es Postman?

Postman es un entorno de desarrollo de API y un práctico cliente HTTP para probar sitios web. Con Postman, puede crear diversas consultas que varían en propósito (Get, Put, Post y más) y unirlas en colecciones. Puede distribuir las colecciones que cree entre sus colegas. Estas colecciones son una especie de suites de prueba que puede mover de un proyecto a otro con los ajustes pertinentes. Además, la herramienta se puede utilizar para pruebas automatizadas de aplicaciones, incluidas las extensiones de Magento. Solo necesita usar la interfaz de la aplicación para configurar y guardar sus pruebas.

Probamos este enfoque al probar los archivos adjuntos de productos de Magento 2 , la extensión que proporciona el seguimiento y la administración de los archivos que adjunta a los productos a través de la API.

Así que ahí vamos.

Configuración del entorno

Es el punto de partida de cualquier actividad de prueba. Con Postman, puede configurar el entorno en 3 pasos relativamente simples:

1. Abra el formulario Administrar entornos :

2. Ahora necesitamos establecer variables. En nuestro caso son:

•  magento_api_url : https://magentourl/index.php/rest
•  admin_username : su nombre de usuario administrador
•  admin_password : su contraseña de administrador

3. Ahora debemos seleccionar el entorno creado:

Ahora podemos usar las variables que acabamos de configurar en otras consultas.

Prueba de los archivos adjuntos del producto Magento 2: API backend

En nuestros ejemplos, la interacción con la API requiere autorización. Entonces, lo primero que debe hacer es obtener el token de administrador . Con la ayuda de este token, obtendrá acceso a su backend de Magento 2 a través de Postman.

Para obtener el token, inicie una solicitud  de publicación :

Ahora haz clic en Enviar .

En respuesta a la solicitud, Postman genera el token de administración :

Usaremos este token para probar los archivos adjuntos de productos Magento 2 con Postman.

Entonces, ¿cuáles son las operaciones básicas que realizan los administradores en los archivos adjuntos de productos de Magento 2?

Estas operaciones son cargar, ver, editar y eliminar el archivo. Para burlarse de ellos en Postman, necesitaremos las consultas Get , Post , Put , Search y Delete .

Consideremos algunos de ellos.

¿Cómo probar la carga del archivo?

Esto requiere la consulta y autorización de Post . Para usar el token de administrador, debe insertar {{adminToken}} en el campo Token . Utiliza el mismo algoritmo cada vez que tengas que realizar alguna acción como Administrador. Así es como se ve:

En primer lugar, debe cifrar la imagen en Base64 . Para cargar el archivo, inserte «cadena» en «base64_encoded_data» . Así es como se lee: “base64_encoded_data”: “cadena”:

Verificamos si el archivo se cargó correctamente y lo configuramos para usarlo en otras solicitudes:

 

La respuesta es positiva y podemos usar el archivo cargado para probar la siguiente consulta ( Guardar archivo cargado ):

¿Cómo probar guardar el archivo cargado?

Ahora tenemos que guardar el archivo subido previamente, y nuevamente necesitamos la consulta Post . Así es como se ve:

Agregamos el archivo cargado “tmp_file” : “{{lastUploadedFile}}” y escribimos los datos del archivo: nombre, etiqueta, etc.

Antes de guardar el archivo, debemos asegurarnos de que se cargó. Entonces lo verificamos con la ayuda de un script de solicitud previa . Este script se ejecuta antes de la solicitud real:

Desarmamos el archivo cargado y configuramos los ajustes para usar el archivo guardado en las últimas solicitudes:

El archivo se guardó correctamente:

El último pero no menos importante. Necesitamos verificar si los datos en el archivo coinciden con nuestra configuración de Adjuntos de productos Magento 2 :

¡Eso es un éxito!

También hay otra opción a considerar: puede guardar el archivo cargado con la ayuda de su URL (usando un campo de enlace).

¿Cómo probar guardar los datos del archivo por URL?

Una vez más necesitamos una solicitud de publicación. Ahora ingresamos la URL que apunta a la ubicación del archivo. Luego configuramos el  nombre del archivo , etiqueta , etc., y hacemos clic en Enviar:

La respuesta es positiva:

Entonces el archivo se guarda.

Ahora pasemos a Obtener consultas .

¿Cómo probar la obtención de datos de archivo por la identificación del archivo?

Las consultas de obtención se utilizan para generar información sobre un determinado archivo adjunto a un producto. Como administrador, puede realizar esta operación para la vista de tienda predeterminada y para todas las vistas de tienda.

Intentaremos obtener los datos de LastSavedId a través de una consulta Get . En primer lugar, configuramos la URL que indica la vista de tienda necesaria y la identificación del archivo:

Aquí también es útil un script de solicitud previa . Antes de generar la información sobre el archivo, debemos asegurarnos de que se haya guardado:

En caso de que falte el archivo, debemos cargarlo y guardarlo .

Ahora verificamos si la información en la configuración de Adjuntos del producto Magento 2 coincide con la información del archivo cargado:

La solicitud de respuesta es positiva:

 

Pasaremos a otra operación importante que ejecutan los administradores: la búsqueda. ¿Por qué buscar archivos adjuntos a los productos? Es posible que necesiten algunas actualizaciones, edición o reemplazo.

Así que ahí vamos.

¿Cómo probar la búsqueda del archivo?

En Postman, podemos  crear consultas de búsqueda por el atributo requerido/cualquiera. También podemos ordenar los resultados de la búsqueda por cualquier valor y orden y establecer el número de resultados que se mostrarán en la sección de respuesta:

Con fines ilustrativos, proporcionamos un ejemplo.

Buscaremos el archivo cuyo nombre comience con «nombre de archivo» y que tenga un tamaño superior a 3000 Bytes. Y los resultados deben ordenarse por ID en orden ascendente con 5 archivos por página. ¿Difícil? Hagámoslo más simple.

En primer lugar, dividiremos la consulta en líneas:

{{magento_api_url}}/all/V1/amasty_product_attachment/filemanage/files?

1. El nombre del archivo comienza con «nombre»:
   
   criterios de búsqueda [grupos de filtros] [0] [filtros] [0] [campo] = nombre de archivo y
   criterios de búsqueda [grupos de filtros] [0] [filtros] [0] [valor] = nombre% y
   criterios de búsqueda [grupos de filtros] [0][filtros][0][tipo de condición]=me gusta&
2. El tamaño es superior a 3000 bytes:
    criterios de búsqueda [grupos de filtros] [0] [filtros] [1] [campo] = tamaño y
   criterios de búsqueda [grupos de filtros] [0] [filtros] [1] [valor] = 3000 &
   criterios de búsqueda [grupos de filtros] [0 ][filtros][1][tipo de condición]=gt&
3. Los resultados se ordenan por ID en orden ascendente: 
   
   searchCriteria[sortOrders][0][field]=file_id&
   searchCriteria[sortOrders][0][direction]=ASC&
4. El número de archivos por página es 5 y el número de páginas para ver es 1:
   
   searchCriteria[pageSize]=5& searchCriteria[currentPage]=1

Hemos subido 3 archivos y 2 de ellos cumplen con la consulta de búsqueda:

¿Es correcta la consulta? Compárelo con la configuración de archivos adjuntos del producto Magento 2:

Los resultados coinciden. ¡Bingo!

Y aquí viene la última e importante operación que ejecuta un administrador: eliminar los archivos adjuntos del producto.

Entonces, verifiquemos si funciona en los archivos adjuntos de productos de Magento 2.

¿Cómo probar la eliminación de un archivo?

Siempre llega un momento en que es necesario eliminar un archivo. Por lo tanto, es imprescindible asegurarse de que un administrador pueda eliminar un archivo.

Para fines de prueba, elegimos eliminar el último archivo guardado. Para hacerlo, ingresamos la identificación del archivo en la URL y verificamos si el archivo se guardó con un script de solicitud previa:

Cuando se guarda el archivo, podemos volver con seguridad a probar la función de eliminación y desarmar el archivo:

Acabamos de eliminar el último archivo guardado.

Ahora verificamos la configuración de los archivos adjuntos del producto Magento 2 para asegurarnos de que el archivo se eliminó:

Entonces la función Eliminar se ejecuta con éxito.

Continuará…

Hemos descrito las pruebas de la API de Magento 2 con Postman desde el punto de vista de las interacciones del administrador.

Gracias al esfuerzo conjunto de todos los miembros de nuestro equipo, nos aseguramos de que nuestra API sea completamente funcional, para que los usuarios puedan trabajar con ella sin complicaciones.

Pero, ¿qué pasa con la API Frontend?

Será la segunda parte de nuestra serie de pruebas API de Magento 2, así que estad atentos.

¿Alguna idea sobre cómo probar la API de backend?

¡No dude en enviarnos una línea a continuación!