Cómo funciona la API REST de Woo­Co­m­me­r­ce

A través de la API REST de Woo­Co­m­me­r­ce, puedes acceder de forma remota al área de ad­mi­ni­s­tra­ción de tu tienda Woo­Co­m­me­r­ce. Las ope­ra­cio­nes ele­me­n­ta­les como “Read” o “Create” se gestionan mediante pe­ti­cio­nes HTTP. Esta API de Woo­Co­m­me­r­ce se puede activar di­re­c­ta­me­n­te en el backend.

¿Qué es una API REST?

En una API REST se definen los recursos de un sistema, a los que se puede acceder mediante REST (Repre­se­n­ta­tio­nal State Transfers). Este tipo de interfaz es una de las mejores so­lu­cio­nes para que los sistemas ha­bi­li­ta­dos para la web se co­mu­ni­quen de forma fácil y eficaz entre el cliente y el servidor. A cada recurso se le asignan pa­rá­me­tros que lo describen y que pueden ser mo­di­fi­ca­dos. Las ar­qui­te­c­tu­ras REST se realizan mediante el protocolo HTTP, por el que todos los recursos pueden dirigirse a través de un único URI (Uniform Resource Ide­n­ti­fier). Los pa­rá­me­tros se añaden como pa­rá­me­tros URL y los recursos se controlan mediante las acciones HTTP estándar GET, POST, PUT y DELETE.

¿Para qué se utiliza una API REST en Woo­Co­m­me­r­ce?

La ca­ra­c­te­rí­s­ti­ca más im­po­r­ta­n­te de la API de Woo­Co­m­me­r­ce para el acceso REST es su uni­ve­r­sa­li­dad. Fue de­sa­rro­lla­do para que las tiendas Woo­Co­m­me­r­ce puedan in­ter­ac­tuar fá­ci­l­me­n­te con otras páginas web o servicios a través de Internet. Esta versátil in­ter­ac­ti­vi­dad con otras apli­ca­cio­nes web beneficia no solo a los de­sa­rro­lla­do­res, sino también a todos los usuarios de la pla­ta­fo­r­ma de la tienda, como de­mue­s­tran los si­guie­n­tes ejemplos de las ventajas de uso de la API de Woo­Co­m­me­r­ce:

• Acceso in­de­pe­n­die­n­te de la pla­ta­fo­r­ma: puedes acceder al panel de control de Woo­Co­m­me­r­ce di­re­c­ta­me­n­te con una apli­ca­ción de terceros gracias a la API REST.
• Fácil in­te­gra­ción de la lógica em­pre­sa­rial: el software y el hardware es­pe­cí­fi­cos para el negocio, como los werables o los di­s­po­si­ti­vos de se­gui­mie­n­to IoT, pueden in­te­grar­se fá­ci­l­me­n­te en el proyecto gracias a la API REST de Woo­Co­m­me­r­ce.
• Si­n­cro­ni­za­ción de datos op­ti­mi­za­da: las empresas que quieran si­n­cro­ni­zar los datos de di­fe­re­n­tes pla­ta­fo­r­mas y canales con la tienda Woo­Co­m­me­r­ce tienen preparada la interfaz adecuada con la API REST.
• In­de­pe­n­de­n­cia del backend de Woo­Co­m­me­r­ce: al activar la API universal de Woo­Co­m­me­r­ce, te in­de­pe­n­di­zas del backend de Woo­Co­m­me­r­ce o de WordPress. Puedes integrar y utilizar tu propia área de ad­mi­ni­s­tra­ción en cualquier momento.
• Fácil in­te­gra­ción de datos de terceros: a través de la interfaz REST, puedes acceder có­mo­da­me­n­te a todos los datos de terceros basados en la apli­ca­ción.
• Vi­n­cu­la­ción con apli­ca­cio­nes móviles: si quieres vincular tu tienda Woo­Co­m­me­r­ce con una apli­ca­ción móvil, esto se si­m­pli­fi­ca co­n­si­de­ra­ble­me­n­te gracias a esta versátil interfaz.

Guía paso a paso: cómo utilizar la API REST de Woo­Co­m­me­r­ce

Si quieres utilizar la API de Woo­Co­m­me­r­ce para in­ter­ac­tuar con otras apli­ca­cio­nes y servicios web, primero debes activarla generando una clave API. También es necesario instalar un cliente para el acceso REST. En las si­guie­n­tes secciones hemos resumido los pasos a seguir:

Paso 1. Generar la clave API REST de Woo­Co­m­me­r­ce

Para utilizar la API REST de Woo­Co­m­me­r­ce, primero debes crear una clave API. Esta clave re­pre­se­n­ta un control de acceso y será utilizada po­s­te­rio­r­me­n­te por Woo­Co­m­me­r­ce para au­te­n­ti­car las pe­ti­cio­nes REST.

Para generar una clave, haz lo siguiente:

1. Inicia sesión en el backend de Woo­Co­m­me­r­ce o WordPress.
2. Abre el elemento “Woo­Co­m­me­r­ce” a través del menú lateral izquierdo.
3. Haz clic en “Settings”.
4. Cambia la pestaña a “Advanced”.
5. Se­le­c­cio­na el submenú “API REST”.
6. Pulsa “Add key” o “Create API key”.

Close

Para la clave, deben in­tro­du­ci­r­se tres elementos: en “De­s­cri­p­tion” debes in­tro­du­cir una breve in­fo­r­ma­ción con la que se reconoce la clave. En la línea “User”, se­le­c­cio­na el usuario de Woo­Co­m­me­r­ce para el que se va a generar el acceso a la interfaz. En “Pe­r­mi­s­sio­ns”, determina si el usuario debe tener solo acceso de lectura, de escritura o ambos. Tan pronto como confirmes tus entradas con “Create API key”, Woo­Co­m­me­r­ce generará dos cadenas al­fa­nu­mé­ri­cas, Consumer key y Consumer secret, así como un código QR. Copia las dos claves y guarda las cadenas en un documento. Lo ne­ce­si­ta­rás más adelante cuando quieras acceder a la API de Woo­Co­m­me­r­ce con un cliente REST.

Close

Paso 2. Descargar el cliente API

En cuanto hayas generado una clave, podrás enviar tus so­li­ci­tu­des a la interfaz del sistema de la tienda. Sin embargo, para ello es necesario un cliente de la API con el que se pueda realizar las pe­ti­cio­nes y vi­sua­li­zar las re­s­pue­s­tas recibidas.

Entre los clientes más populares para el acceso REST se en­cue­n­tran Insomnia y Postman. Ambas he­rra­mie­n­tas están di­s­po­ni­bles como apli­ca­cio­nes de es­cri­to­rio para Windows, macOS y Linux. Postman, que uti­li­za­mos en el contexto de este tutorial, también se puede utilizar como una apli­ca­ción web di­re­c­ta­me­n­te en el navegador.

La in­s­ta­la­ción y puesta en marcha de Postman funciona de la siguiente manera:

1. Ve a la página de descarga de Postman y descarga la versión adecuada para tu sistema.
2. Haz doble clic en el archivo de in­s­ta­la­ción de Postman.
3. Crea una cuenta de Postman: solo tienes que in­tro­du­cir una dirección de correo válida, un nombre de usuario y una co­n­tra­se­ña. También puedes re­gi­s­trar­te con una cuenta activa de Google.
4. Introduce la in­fo­r­ma­ción so­li­ci­ta­da y envía los enlaces de in­vi­ta­ción a tus colegas (si lo deseas).

Close

Paso 3. Enviar la solicitud de la API de Woo­Co­m­me­r­ce

Tras la co­n­fi­gu­ra­ción, puedes probar el acceso a la API REST enviando una primera solicitud. Para ello, abre tu Workspace y haz clic en “Create new request”.

Close

Para la primera prueba, elige una petición GET para recuperar datos. El método está se­le­c­cio­na­do por defecto en Postman, así que puedes mantener la selección. En la línea de dirección, después del “GET”, introduce la siguiente dirección. Pero en lugar de woo­co­m­me­r­ce-domain.xyz, utiliza la dirección de tu tienda Woo­Co­m­me­r­ce:

https://woocommerce-domain.xyz/wp-json/wc/v3/orders

A co­n­ti­nua­ción, añade tus datos para la au­te­n­ti­ca­ción con la API REST de Woo­Co­m­me­r­ce. Aquí depende de si el acceso REST tiene lugar a través de HTTP o HTTPS (re­co­me­n­da­do). Cambia la pestaña “Au­tho­ri­za­tion” y se­le­c­cio­na “OAuth 1.0” para HTTP o “Basic Auth” para HTTPS en “Type”. A co­n­ti­nua­ción, introduce los códigos guardados de Consumer key y Consumer secret; en el caso de la au­te­n­ti­ca­ción básica, debes in­tro­du­cir el Consumer key en “Username” y el Consumer secret en “Password”.

Close

Una vez co­n­fi­gu­ra­da la au­te­n­ti­ca­ción, pulsa el botón “Send” y se iniciará la consulta. En el caso de la dirección definida an­te­rio­r­me­n­te, utiliza la solicitud GET para consultar todos los pedidos actuales. Postman presenta el resultado re­s­pe­c­ti­vo en la ventana inferior op­cio­na­l­me­n­te en los formatos JSON, XML, HTML o texto.

Close