Conexiones API REST a Magento

Tal vez ya tienes tu E-Commerce o utilizas Magento de forma habitual pero no sabes como realizar conexiones API REST utilizando método POST y GET.

Aquí en 3D Advertising S.A. de C.V. te explicaremos de una manera muy simplificada como realizar este tipo de conexiones.

Si aun no sabes acerca de Magento te recomendamos leer nuestra entrada ¿QUE ES MAGENTO?.

Magento

¿Qué necesitamos?

Este tipo de conexiones se pueden realizar de diferentes formas ya sea creando un script desde PHP o algún otro lenguaje de programación que prefieras o simplemente utilizando plataformas que cumplan con esta función como, por ejemplo:  SoapUI o Postman, en este caso utilizaremos este último.

Existen diferentes métodos HTTP, cada uno de ellos utiliza una sintaxis diferente y son utilizados para distintas circunstancias, entender su funcionamiento es fundamental para utilizar la arquitectura REST.

En este caso veremos los dos mas utilizados y sus principales diferencias.

Método POST y GET

POST

El método POST se utiliza para enviar datos a un recurso en específico, causando a menudo un cambio en el estado o efectos secundarios en el servidor.

Envió o actualización de datos.

GET

El método GET solicita una representación de un recurso específico. Las peticiones que usan el método GET sólo deben recuperar datos.

Recuperación de datos.

Autenticando vía Token utilizando método POST

En este caso realizaremos autenticación vía Token, una vez abrimos Postman y creamos una nueva solicitud podemos ver atreves de un menú desplegable los diferentes métodos.

metodos-postman
En este caso elegiremos POST ya que lo que realizaremos es enviar nuestro usuario y contraseña de nuestra cuenta de Magento y nosotros recibiremos como respuesta un token que utilizaremos para nuevas solicitudes.

Del lado derecho del método seleccionado hay un espacio donde ingresaras la URL expuesta a la cual haremos la solicitud.

Colocando el dominio que apunta a nuestra tienda Magento seguida de :

/rest/V1/integration/admin/token

Quedando de esta forma:

https://tu-dominio- magento.com/rest/V1/integration/admin/token

Todas estas URLs expuestas puedes obtenerlas directamente desde la documentación oficial.

A continuación, darás clic en la pestaña Headers y en la columna KEY colocaras Content-Type y en la columna Value colocaras application/json tal como se muestra en la imagen inferior.

Headers-Postman
Básicamente lo que estamos indicando en el encabezado es que realizaremos un envió de datos mediante método POST en formato JSON.

Posteriormente darás clic en la pestaña Body y la parte inferior a esta seleccionaras raw donde se abrirá un espacio para que nosotros podamos escribir nuestro JSON de forma manual y lo ingresaremos de la siguiente forma:

JSON-Postman

Teniendo cuidado con colocar cada una de las comillas, comas, llaves, etc., y en el texto color azul ingresaras el usuario y contraseña de tu instalación Magento.

Una vez que hayas colocado ese JSON con tus credenciales darás clic al botón Send y si todo esta correcto en la parte inferior de la pantalla podrás ver tu Token de acceso como en la imagen inferior.

Con esto habremos terminado este envío de datos mediante método POST.

Token de acceso: cadena de caracteres color rojo

Obteniendo datos de clientes utilizando método GET

En este segundo ejemplo realizaremos una petición mediante método GET obteniendo la información de un cliente.

Lo primero que debes hacer es al igual que en el ejercicio anterior crear una nueva solicitud, ir al menú desplegable y esta vez seleccionaremos GET

Y del lado derecho colocaras tu dominio seguido de /rest/V1/customers/1

Quedando de esta forma:

https://tu-dominio- magento.com/rest/V1/customers/1

Donde el numero 1 corresponde al ID del cliente al cual queremos obtener sus datos.

Metodo-GET

Después daras clic en la pestaña Authorization, en Type seleccionaras Bearer Token y del lado derecho en la caja de texto ingresaras el Token que generamos anteriormente en el método POST.

Autenticacion

Ahora darás clic al botón Send y si todo está correcto en la parte inferior de la pantalla podrás ver nuestra la información del cliente al cual colocamos el ID en formato JSON.

Respuesta-GET

Con esto habremos terminado dos diferentes conexiones API REST a Magento, recuerda que para conocer las diferentes URLs expuestas con las que Magento cuenta puedes consultarlas directamente en la documentación oficial donde podrás encontrar: consulta y creación de productos, clientes, ordenes, revisión de inventarios, borrado de datos, entre muchas otras mas.

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *