Blog
Configurar Servicios web API en Magento 2
¿Es claro el concepto? ¿cuando se lee se entenderá? o más bien se relaciona con un servicio web, no se como lo vean los demás pero en mí opinión cuando veo Servicio Web sé que estamos hablando de WebServices, pero ¿como puedo llevar eso a Magento? y lo que siempre he pensado como empiezo y por donde, en este articulo intentare explicarlo con mis palabras y como es clásico de mí mostrar la parte sencilla y fácil de entender, la explicación con manzanas para lograr no aprender a hacer estos componentes sino más bien a entender su importancia, por que deberíamos aprender a crearlos y al final sera sencillo.
Bien ahora comentare un poco cual es la importancia de este concepto en Magento, y es algo muy sencillo de entender, que pasa si necesito comunicarme con una tabla interna de Magento para obtener datos que necesito para generar algún reporte más sofisticado hablando de alguna tabla personalizada de algún componente o plugin, o que pasa si lo que necesito no me lo brinda al API nativa de Magento, pues es aquí en donde entraría este concepto la flexibilidad que tiene Magento para lograr ampliar la gama de posibilidades, y pues bueno para lograrlo hay que saber como hacerlo y aquí es donde entro yo, voy a mostrar como hacerlo.
Para que esto se pueda digerir de la forma más sencilla voy a enfocarme en una receta como si hablara de una receta para cocinar algo, así se me hace más sencillo para mí expresarlo y creo que sé podra entender muy bien, lo que voy a listar a continuación son lo que necesitamos saber y conocer cada elemento para lograr crear algo:
- Realizar una configuración XML
- Ingredientes del Archivo de configuración XML
- Preparando el Archivo de configuración XML
- Sazonando el Archivo de configuración XML
- Los toques finales y el componente está listo
Realizar una configuración XML
como podrá notarse a simple vista siempre hablamos de un archivo XML y basta recordar que en Magento 2 cuando hablamos de archivos de configuración nos estamos refiero a archivos XML, así que esta no es la excepción y para lo cual aquí es donde explicara de que va este archivo cual es su funciona ante todo esto, a donde y como es que deberíamos crearlo.
Lo primero es, muy sencillo y es basta con entender que para poder realizar un componente de WebService en Magento 2, se requiere de crear un archivo XML que crearemos y colocaremos en una ruta especifica de un módulo, este archivo XML es el que le indicara a Magento que existe un llamado externo a través de esta configuración, cuales son los métodos que estarán disponibles al llamado, así como los elementos que se le puedan enviar y la URL de invocación.
Ingredientes del Archivo de configuración XML
Ahora necesitamos los ingredientes para empezar a preparar el Web Services, aquí lo explicare como yo lo entendió, bien tengo la necesidad de comunicarme con datos internos en Magento que la API no me da lo que estoy buscando, así que requiero hacer algo más, pues bien como podría comunicarme con el alma de Magento con lo que tiene dentro con los datos de sus tablas pues puede haber muchas formas pero la más segura y flexible es a través de una comunicación que por un lado me permita indicarle que quiero hacer a donde me quiero comunica con que datos exactamente y lo mejor aún que tenga una llave de acceso un nivel de seguridad que sin esa llama no pueda conectarme por ningún motivo y eso lo hace muy Robusto y Flexible, así que en este punto los ingredientes que necesito es:
- Crear un archivo XML llamado webapi.xml
- Crear una llave de comunicación con Magento mediante el XML
- Crear un par de script en PHP
Aquí lo que sucederá es que se debe dejar el archivo XML en algún lugar donde me lo pida Magento y segundo cuando él tome ese archivo lo cargue a sus sistemas en cuanto yo empiece a realizar peticiones de la información el me preguntara si tengo la llave de acceso y si la tengo y es valida podre entrara y obtener la información que estoy esperando encontrar, suena muy sencillo no.
Preparando el Archivo de configuración XML
Hay algo importante antes de pasar a desarrollar nuestra receta o en este caso la construcción de los archivos necesarios para el servicio web, hay que entender una parte muy importante si estas aquí leyendo este texto es por que eres programador Magento tal vez no avanzado pero si tienes las nociones y lo digo por que lo que empezaré a mencionar a continuación son las cosas básicas de realizar un modulo en Magento, sin ir tan legos el simple echo de entender que es una clase, que es un XML como hacer una función etc, son todos conceptos que ya deberías conocer por que si no es así claramente no estas en el lugar correcto.
webapi.xml
bien lo primero vamos al archivo importante en todo esto y no quiero decir que el resto no lo sean si no mas bien empezaremo por lo mas baisco que de el dependera el buen funcionamiento, este archivo es el encargado de decirle a Magento 7 parametros de configuración, recordemos que
