API REST de WooCommerce: Guía de integración, administración y resolución de problemas

Su sitio web de comercio electrónico suele implicar costes elevados y mucho trabajo manual, como la actualización periódica del inventario o la tramitación de pedidos. Mientras que WooCommerce API REST Poder ayudar a los administradores a gestionar la tienda de forma más eficiente con código reduce estas tareas.

Gracias a las API, es posible automatizar procesos, conectar la tienda a otras herramientas y gestionar las tareas diarias sin necesidad de hacerlo manualmente. Desde actualizar los detalles de los productos hasta gestionar los pedidos, lasAPI REST Esto puede hacerse fácilmente con una simple petición HTTP.

En este artículo se describe cómoIntegración con la API REST de WooCommerceTambién explica cómo probarlo y cómo utilizarlo para gestionar el producto, así como los pasos para solucionar problemas en caso de que surjan.

¿Qué es una API REST y cómo funciona?

Una API REST es una forma de que las aplicaciones de software se comuniquen entre sí a través de Internet. Su nombre completo es Transferencia de estados representativos(transferencia expresiva de estados) y siguen una serie de principios rectores que hacen que la integración sea sencilla y escalable.

Cuando un cliente solicita información al servidor a través de la API REST, el servidor devuelve el estado actual del recurso solicitado en un formato estandarizado.La API REST utiliza peticiones HTTP para realizar funciones estándar de bases de datos, como hacer una CRUD(crear, leer, actualizar, eliminar).

junto con SOAP en comparación con otras tecnologías comoREST Es más popular porque utiliza menos ancho de banda y se adapta mejor al entorno de Internet.

Ya hemos publicado un artículo sobreAPI RESTPara más detalles sobre el artículo, véaseManual de la API REST de WooCommerce: Explicación exhaustiva y casos prácticos.

Ventajas de utilizar la API REST en WooCommerce

Hay muchas ventajas de utilizar la API REST en WooCommerce, incluyendo:

• Admite la interoperabilidad multiplataformaLa API REST permite una comunicación fluida entre múltiples plataformas.
• Ofrece flexibilidad de desarrolloLos desarrolladores tienen flexibilidad para crear aplicaciones según sus necesidades.
• Permite la conectividad con distintos dispositivos: Se conecta fácilmente a una gran variedad de dispositivos a través de una API REST.
• Sincronización de datos simplificadaLa API REST facilita la sincronización de datos.
• Fácil acceso a contenidos de terceros: Utilice la API REST para una rápida integración y acceso a contenidos de terceros.

Requisitos para utilizar la API REST de WooCommerce

Para utilizar la API REST de WooCommerce, cumpla estas condiciones:

1. WooCommerce 3.5 y superior
2. WordPress 4.4 y superior
3. Activar enlaces fijos(Ruta: Configuración > Enlace permanente)
4. Activar HTTPS para un acceso seguro a la API(Recomendado)
5. Probar la API REST de WooCommerce con Postman o Insomnia

En este tutorial, se utilizará la última versión de WooCommerce y WordPress. asegúrese de que los enlaces fijos de WordPress son legibles por humanos (Path:Configuración > Enlaces fijos). Seleccionaré "Título del artículo", pero para una mejor compatibilidad, es posible seleccionar todas las opciones excepto "sin adornos"Cualquier formato distinto de

Pasos:

1. salir para Panel de control → Configuración → Enlaces fijos.
2. Seleccione "Título del artículo" y pulse en la parte inferior "Guardar cambios"Botón

¿Cómo integrar la API REST de WooCommerce?

Una API es una herramienta que permite a distintas aplicaciones informáticas comunicarse entre sí. Por ejemplo, aplicaciones como PayPal Una pasarela de pago de este tipo se conecta al sitio de comercio electrónico a través de una API, procesando así las transacciones de forma segura sin necesidad de crear una funcionalidad de pago propia.

La API REST de WooCommerce lee y escribe datos de la tienda, incluyendo pedidos, productos y clientes. Por ejemplo, si tienes una tienda online de ropa, puedes utilizar la API para actualizar automáticamente el inventario cuando se agoten los productos.

Utilizando la API de WooCommerce, siga los pasos que se indican a continuación:

Paso 1: Configurar y acceder a la API de WooCommerce

Para utilizar la API de WooCommerce, primero necesitas tener instalado WooCommerce en tu sitio web. si no tienes un sitio web, puedes consultar nuestro tutorial para crear uno:

Los novatos también pueden empezar rápidamente: AliCloud + Pagoda panel para construir el sitio de WordPress estrategia completa

Tutorial ultradetallado para la instalación manual de WordPress en Tencent Cloud mediante 1Panel

Una vez que el sitio WooCommerce está listo, es necesario generar una clave de API para autenticar la solicitud de API. Los pasos son los siguientes:

• Vaya a la página de configuración de WooCommerce y haga clic en el botón "Avanzado" y seleccione "API REST".

• Aquí se pueden generar claves para cada usuario que necesite acceso a la API.

A continuación, es necesario seleccionar un Puntos finales de la APIWooCommerce proporciona múltiples puntos finales para acceder a diferentes tipos de datos, como pedidos, productos, clientes, etc. Seleccione el punto final que corresponda a los datos a los que desea acceder o modificar.

Completados estos pasos hasta ahora:Se instala WooCommerce, se generan las claves API y se selecciona el punto final correcto para acceder a los datos de la tienda o modificarlos.

Paso 2: Crear clave API en WooCommerce

En el Paso 1, hemos configurado WooCommerce y preparado el entorno API. Ahora, en el Paso 2, hay que generar la clave API. Este paso es fundamental porque la clave API se utilizará para autenticar todas las solicitudes de datos de la tienda, ya sea para recuperar pedidos, actualizar productos o gestionar clientes.

El proceso de creación de una clave API en WooCommerce es muy sencillo, unos pocos pasos:

• Inicie sesión en el panel de control de WordPress.
• salir para WooCommerce → Configuración.

• hacer clic (con un ratón u otro dispositivo señalador)"Avanzado"y, a continuación, haga clic en"API REST"Tab.

• hacer clic (con un ratón u otro dispositivo señalador)Añadir claves/Crear claves APIpara crear una nueva clave API.

existe descripciones Introduzca en el campo una descripción de la clave API.

a través de (un hueco) usuario para seleccionar el usuario que desea asociar a esta clave de API. Si no ve el usuario que desea utilizar, es posible que tenga que crear primero un nuevo usuario.

a través de (un hueco) ámbito de la propia jurisdicción para seleccionar los permisos que se concederán a esta clave de API. Se pueden seleccionar los siguientes tipos de permisos:

• Permisos de lectura/escritura (Read/Write)
• Permisos de sólo lectura (Read-only)
• Permisos de sólo escritura (Write-only)

• hacer clic (con un ratón u otro dispositivo señalador)Generación de claves APIpara generar una clave API.

garantizan que Clave del consumidor responder cantando Secreto del consumidor Los valores se copian y se guardan en un lugar seguro, ya que no podrá volver a verlos.

Esto crea con éxito una clave API en la tienda WooCommerce que le permite acceder y manipular los datos de la tienda mediante programación.

Paso 3: Comprobar que la API REST de WooCommerce funciona correctamente

A continuación, debe comprobar que la API REST funciona correctamente. Siga los pasos que se indican a continuación para verificar la funcionalidad del punto final de la API REST:

Habilitación de API REST más antiguas
El primer paso es habilitar la API REST anterior. Antes de WooCommerce 9.0, esto se podía hacer yendo a la sección Ajustes → Avanzadopara activar la opción de la antigua API. Sin embargo, ahora es necesario instalar una nueva API llamada API REST heredada de WooCommerce El complemento de extensión específico para

Una vez finalizada la instalación, vuelve a mirar las opciones de la antigua API y verás el icono "Las API REST más antiguas están habilitadas" La marca de verificación del

El siguiente paso es realizar pruebas en las plataformas API. La API REST se probará en dos bancos de pruebas de API:Carteroresponder cantandoInsomnio.

Probar la API REST de WooCommerce en Postman

Cartero es una plataforma para construir y utilizar APIs. Para probar APIs en Postman, primero necesitas registrar una cuenta.

La URL de solicitud que probaremos es wp-json/wc/v3/pedidos. En mi sitio, la URL completa es similar:
https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/ordersDeberá cambiar la URL por la de su propio sitio web. Deberá cambiarla por la URL de su propio sitio web.

Después de iniciar sesión con éxito en Postman, siga los pasos que se indican a continuación para realizar la prueba de la API REST:

1. Abra una nueva pestaña y visite Documentación de la API REST de WooCommerce.
2. Abra Postman en otra pestaña de su navegador.
3. Vaya a la documentación de la API REST de WooCommerce y busque la función Pedidos(Orden).
4. Copie el código del panel derecho del documento.
5. Consulte la siguiente captura de pantalla para continuar.

Para facilitar el seguimiento de este tutorial, aquí está el código que hay que copiar:

curl -X POST https://example.com/wp-json/wc/v3/orders \
    -u clave_consumidor:secreto_consumidor \
    -H "Content-Type: application/json" \
    -d '{
  "payment_method": "bacs",
  "payment_method_title": "Transferencia bancaria directa",
  "set_payment": true,
  "billing": {
    
    
    "address_1": "969 Market", "address_2": "
    "address_2": "", "city": "San Francisco".
    
    "estado": "CA", "código postal": "9410".
    
    
    "correo electrónico": "john.doe@example.com", "teléfono":"(555)
    "phone": "(555) 555-5555"
  }, "shipping": {{{{{}}}
  "shipping": {
    "first_name": "John", "last_name": {
    
    "dirección_1": "969 Market", "dirección_2": "".
    
    
    "estado": "CA", "código postal": "9410".
    "código postal": "94103", "país": "US".
    "country": "US"
  }, "line_items".
  "line_items": [
    {
      "product_id": 93, "quantity": 2
      "quantity": 2
    }, { "line_items": [ "product_id": 93, "quantity": 2
    {
      "product_id": 22, "variation_id": 23, {
      "variation_id": 23, "quantity": 1
      "cantidad": 1
    }
  ], "shipping_lines": [ "product_id": 22 "variation_id": 23 "quantity": 1 }
  "shipping_lines": [
    {
      "method_id": "flat_rate", "method_title": "Tarifa plana", "shipping_lines": [ {
      "method_title": "Tarifa plana",
      "total": "10.00"
    }
  ]
}'

• Después de copiar el código, devuelveCarteroTab.
• hacer clic (con un ratón u otro dispositivo señalador)"Favoritosy luegoHaga clic en "Importar"..

• Pegar desdeAPI REST de WooCommerceDocumente el código de pedido copiado y, a continuación, haga clic en"Importar a la colección"Botón.

• opciónTipo de solicituddebido aGET.

• compiladorSolicitar URLUtilice la URL de su propio sitio.

• Elige ahoraTipo de autorización. Por esta razón, la elección deAutenticación básica.
• ID de usuarioresponder cantandocriptográficoen WooCommerce.clave de consumoresponder cantandoconsumidoresLlave. Si la memoria no me falla, esta es la clave que se utilizó en el paso 2 Lo que se guarda al final. Por último, haga clic en "enviando"botones.

• Si la tienda WooCommerce se ha configurado correctamente con la API REST activada y la clave API generada, debería ver un icono Respuesta JSONque contiene una lista de productos de la tienda. La respuesta debería tener el siguiente aspecto:

Probando la API REST de WooCommerce en Insomnia

La segunda plataforma utilizada para probar la API REST esInsomnioPara ello, primero tiene que instalar Insomnia en su sistema. Para ello, primero tiene que instalar Insomnia en su sistema. después de la instalación, siga los siguientes pasos para realizar la prueba de la API REST.

• hacer clic (con un ratón u otro dispositivo señalador)"Nuevas colecciones".

• Para su colecciónchristen.

• hacer clic (con un ratón u otro dispositivo señalador)"Nueva petición HTTP".

• opciónTipo de solicituddebido aGET.

• compiladorSolicitar URLpara utilizar la URL de su propio sitio.

• Para la autorización, seleccioneAutorización básica.

• ID de usuarioresponder cantandocriptográficode WooCommerce.clave de consumoresponder cantandoconsumidoresLlave.

• golpe (en el teclado)enviandobotón. En laVista en el panel derechoFormato JSONLos resultados de la

Si recibe una respuesta como ésta, ¡enhorabuena! La API REST funciona.
Si encuentra un error, vuelva a comprobar las credenciales de la API y que la API REST está correctamente habilitada en WooCommerce.

¿Cómo funciona la API REST de WooCommerce?

La API REST de WooCommerce se basa en los principios de REST (Representational State Transfer) y puede interactuar con datos de la tienda como pedidos, productos y clientes utilizando métodos HTTP estándar:

• GETRecuperar datos (por ejemplo, obtener una lista de pedidos)
• POSTCrear nuevos datos (por ejemplo, añadir un nuevo producto)
• PUTActualizar los datos existentes (por ejemplo, el estado de la orden de modificación)
• BORRARBorrar datos (por ejemplo, eliminar clientes)

Cada interacción se realiza a través delpunto de partida o de llegada (en historias, etc.)hecho, estos puntos finales son URL estructuradas que representan recursos específicos. por ejemplo, para recuperar un pedido, puede utilizar el punto final /wp-json/wc/v3/orders/{order_id}. Estos puntos finales se basan en una estructura de recursos, lo que significa que cada URL representa un tipo específico de datos en el sistema.

La API utiliza la comunicación sin estado, lo que significa que cada solicitud del cliente al servidor debe contener toda la información que el servidor necesita para completar la solicitud.

Los datos suelen presentarse como JSON El formato es de intercambio, lo que facilita el manejo de datos en aplicaciones web. Cada solicitud API debe ser autenticada, normalmente utilizando una clave API (que puede ser generada en WooCommerce) u otros métodos (como el método OAuth).

La API admite diversas herramientas de prueba e integración, como Cartero responder cantando InsomnioFacilitan el envío de solicitudes y la visualización de respuestas.

Para la mayoría de los usuarios, la integración con un servicio externo es muy sencilla y normalmente solo implica generar una clave API y compartirla con el servicio externo para establecer una conexión. Una vez establecida la conexión, el servicio externo puede interactuar con la tienda WooCommerce utilizando la API proporcionada.

Cómo gestionar productos (añadir/editar/eliminar) a través de la API REST

En la sección anterior, la API REST de WooCommerce ha sido probada usando Postman e Insomnia, y ahora puede ser usada para gestionar productos en la tienda.

Uso de WooCommerce Objetos de producto para gestionar los productos de la tienda. Estos objetos contienen una variedad de atributos, tales como precio(Precio),estado_de_almacenamiento(estado de las existencias) y productos_agrupados(agrupación de productos). Estos atributos facilitan a los administradores el control de aspectos como el inventario, los precios y la categorización de productos a través de la API.

Por ejemplo, para asignar un producto a un grupo, basta con utilizar el identificador del grupo con la tecla productos_agrupados es suficiente.

Hay dos atributos clave a la hora de gestionar el inventario:

1. gestionar_stockFijar en verdadero tal vez falsoActivar o desactivar la gestión del inventario.

2. estado_de_almacenamiento: Se utiliza para reflejar el estado actual del producto, los valores opcionales incluyen:

• instock(en stock)
• onbackorder(se aceptan reservas)
• outofstock(no disponible)

A continuación, aprenderemos a añadir o actualizar detalles de productos mediante programación.

Añadir productos a través de la API de WooCommerce

Para añadir productos a nuestra tienda con Postman, es necesario cambiar el método de solicitud de la opción GET cambiar a POSTy cambiar la URL del punto final a:
https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/products

Procedimiento operativo:

1. Ir a Postman's Ficha Cuerpo.
2. opción En bruto y establezca el formato en JSON.
3. Sustituya el código existente por los siguientes datos JSON:

{
  "nombre": "Macbook Pro M3",
  "type": "simple", "description": "El chip M3 cuenta con 8 núcleos de CPU, 10 núcleos de GPU y un motor neuronal de 16 núcleos para un rendimiento mejorado.
  "description": "El chip M3 cuenta con 8 núcleos de CPU, 10 núcleos de GPU y un motor neuronal de 16 núcleos para mejorar el rendimiento",
  "short_description": "", "description": "El chip M3 cuenta con 8 núcleos de CPU, 10 núcleos de GPU y un motor neuronal de 16 núcleos para mejorar el rendimiento.", "short_description": "",
  
  "tags": [],
  "images": []
}

Este JSON contiene detalles del producto, por ejemploNombre, tipo, descripcióny opcionalcampocomo siCategorías, Etiquetasresponder cantandofotografía.

Una vez introducidos los datos, pulse enviando botón . Si el producto se crea correctamente, se recibe una respuesta que contiene el objeto producto.

Este es un producto añadido a la tienda:

Edición de productos a través de la API de WooCommerce

Supón que no estás contento con un producto añadido previamente y quieres editarlo - también puedes hacerlo con la API de WooCommerce. Todo lo que necesitas saber es que el producto previamente añadido a la tienda tiene un ID. En mi caso, el producto id sea 28.

En este tutorial, cambiamos el nombre del producto que añadimos anteriormente. El procedimiento es el siguiente:

Modifica los datos JSON así:

{
  "name": "Macbook Air M3"
}

Nota: No hemos incluido otros atributos ya que sólo queremos cambiar el nombre del producto. Y como no necesitamos añadir un nuevo producto, solo modificar uno existente, cambiamos la URL del endpoint a:

https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/products<your-id-here>.

En el ejemplo, el producto ID es 28, así que la URL es:

https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/products/28.

A continuación, cambie el método de solicitud a PUTy ejecute la solicitud. Puede confirmar que la actualización se ha realizado correctamente comprobando el nombre del producto actualizado en la tienda.

Este es el nombre del producto actualizado en nuestra tienda:

Eliminar productos a través de la API de WooCommerce

Para retirar el producto, utilizamos BORRAR Método de solicitud. Eliminará los datos previamente actualizados en la tienda Macbook Air M3 - Actualizado Producto. El procedimiento es el siguiente:

Utilice la misma URL de punto final que antes, pero cambie el tipo de solicitud a BORRAR.

Introduzca el ID del producto en la URL del endpoint y haga clic en el botón enviando.

El producto será retirado de la tienda como se muestra a continuación:

Cómo gestionar pedidos a través de REST API (obtener/actualizar el estado del pedido)

La API REST de WooCommerce simplifica el procesamiento de pedidos automatizando tareas como la obtención y actualización del estado de los pedidos. Puede ser fácilmente:

• Obtenga pedidos y fíltrelos por fecha, estado o cliente.
• Actualice el estado del pedido para reflejar las diferentes etapas, por ejemplo, "Completado".
• Gestionar las devoluciones, incluidas la tramitación de solicitudes y la automatización de las devoluciones.

A continuación, vea cómo obtener el pedido más reciente y actualizar el estado del pedido a "hecho".

Obtener pedido

En este ejemplo, tomaremos el pedido más reciente y actualizaremos su estado a "hecho". Para obtener los pedidos más recientes, se necesita un intervalo de fechas y utilizar la función GET Petición.

Así es como utilizo Postman para obtener pedidos recientes:

1. En primer lugar, actualice la URL del punto final a https:///wp-json/wc/v3/orders. La URL tiene este aspecto:
   https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/orders
2. A continuación, como necesito obtener el ID de pedido más reciente, proporcionaré un intervalo de fechas y utilizaré la función después de sólo recibe los pedidos posteriores a hoy. En mi ejemplo, el intervalo de fechas es 2024-09-08t00:00:00No estoy seguro de lo que estoy hablando. Mi URL tiene este aspecto:
   https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/orders?after=2024-09-08T00:00:00

Después de cambiar la URL, vaya a Params, y en la pestaña Value La fecha se añade al campo como se muestra a continuación:

Tras ejecutar la solicitud, podrá ver una lista de los pedidos recientes de la tienda que coinciden con las condiciones de fecha proporcionadas.

En mi caso, el ID del pedido es "id": 25El Estado es "pendiente". Lo cambiamos por "completado"¿De acuerdo?

Actualizar el estado del pedido

Para actualizar el estado del pedido, utilizamos la función PUT Método de solicitud. La URL del endpoint también deberá modificarse para incluir el ID de pedido específico. en este ejemplo, el ID de pedido es 25, por lo que la URL será:

https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/orders/25

A continuación, diríjase a Cuerpo y añada los siguientes datos JSON:

{
  "estado": "completado"
}

La ejecución de esta solicitud actualizará el estado del pedido a hechoEl siguiente es un ejemplo:

Cómo gestionar clientes a través de la API REST (añadir/recuperar ID de cliente)

La gestión e interacción con los clientes es más fácil con la API REST de WooCommerce.

Las empresas pueden:

• Crear y actualizar perfiles de clientes.
• Recupere información de los clientes, como el historial de compras y la configuración de preferencias.
• Utilice estos datos para marketing personalizado, envío de promociones específicas y recomendación de productos.

Esto ayuda a las organizaciones a relacionarse mejor con sus clientes y a impulsar las compras repetidas.

Añadir cliente

Para añadir un cliente, utilice la función POST y cambie la URL del punto final por:
https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/customers

A continuación, en el Cuerpo utilice el siguiente JSON para crear un nuevo cliente:

{
  "email": "a.rehman@gmail.com",
  "first_name": "Abdul",
  
  
  
  "facturación": {
    "first_name": "Abdul", "last_name": "Rehman", "billing": {
    "last_name": "Rehman", "company": "", "company": "abdul.rehman", "customer".
    "empresa": "", "dirección_1": "123".
    "address_1": "123 Main Street", "address_2": "", "address_2": "123 Main Street".
    "address_2": "", "city": "Lahore".
    "ciudad": "Lahore", "estado": "Punjab".
    "state": "Punjab", "postcode": "54000".
    "código postal": "54000",
    
    
    "phone": "(555) 555-5555"
  }, "shipping".
  "shipping": {
    "first_name": "Abdul", "last_name": {
    "last_name": "Rehman", "company": "," "company": "(555)
    "company": "", "address_1": "123".
    "address_1": "123 Main Street", "address_2": ",
    "address_2": "", "city": "Lahore".
    "ciudad": "Lahore", "estado": "Punjab".
    "state": "Punjab", "postcode": "54000".
    "código postal": "54000",
    "country": "PK"
  }
}

Tras ejecutar la solicitud, recibirá una respuesta con los datos del cliente. Asegúrese de anotar losIdentificación del clienteya que se necesita en la siguiente sección para recuperar los detalles de ese cliente.

Puede ver que la información del nuevo cliente se ha añadido con un ID de cliente de"id": 2.

Recuperar información de clientes por ID

Ahora, utilicemos el GET para recuperar la información del cliente basándose en el ID de cliente creado previamente. En mi ejemplo, el ID de cliente es "2".

Añada el ID de cliente a la URL del punto final con el siguiente formato:
https:///wp-json/wc/v3/customers/

La URL de mi punto final es la siguiente:
https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/customers/2

Después de ejecutar la solicitud, puede ver los detalles de este cliente como se muestra a continuación:

Puntos finales disponibles de la API REST de WooCommerce

La API REST de WooCommerce proporciona acceso a diferentes partes de la tienda a través de endpoints. Los endpoints son URLs específicas que realizan varias funciones de la tienda. Por ejemplo, a través de la URL /wp-json/wc/v3/productos que pueden recuperar, crear o actualizar productos en la tienda.

A continuación se muestra una lista de los puntos finales clave, junto con los correspondientes fragmentos de código PHP de ejemplo:

resúmenes

En general, la API REST de WooCommerce es una gran herramienta para los usuarios que buscan mejorar su negocio online. Puede conectar tiendas con otras aplicaciones y automatizar flujos de trabajo, ahorrando así tiempo y esfuerzo al optimizar los procesos.