TAGS
Mi característica favorita de la reciente liberación WooCommerce 2.1 es la API REST. Puede que sea un poco parcial, ya que era mi contribución básica durante el ciclo de liberación 2.1, pero sienta un importante trabajo preliminar. Una plataforma como WooCommerce es más fuerte cuando los datos de la tienda se pueden empujar o tirar de otros sistemas, como una aplicación móvil (alerón: una aplicación para el iPhone WooCommerce estará disponible en breve) o una integración compleja con un sistema de contabilidad de back-end.
En esta serie vamos a bucear en cada aspecto de la WooCommerce API REST, a partir de una visión general de la API, seguido de un post en cada tipo de recurso que está disponible. Antes de empezar, recuerde que la API REST sólo está disponible en la versión 2.1 o superior, por lo que si usted está en una versión más antigua que necesita para actualizar primero. ¡Empecemos!
La API REST es de sólo lectura, con la excepción de un único criterio de valoración para la actualización de estado de la orden. Los datos están disponibles en formato JSON (por defecto) o en formato XML. Hay 5 recursos primarios, cada uno con un conjunto relacionado de criterios de valoración:
La API se puede acceder en - anote la versión v1 que tiene una posición de primer orden en todos los URL de punto final. Esto sólo va a cambiar para mayor compatibilidad con versiones y hacia atrás está previsto para al menos una versión principal de vuelta, por lo que se puede construir de manera segura integraciones frente a la versión sin preocuparse por una versión más reciente de WooCommerce romper su código :)
Puede acceder a la API a través de HTTP o HTTPS. Recomiendo encarecidamente el uso de HTTPS siempre que sea posible, ya que hace que la autenticación mucho más fácil. El índice API (véase más adelante) indicará si el soporte SSL sitio o no. Respuestas El formato de respuesta por defecto es JSON, que puede ser cambiado a XML estableciendo el encabezado HTTP Accept en application / xml. Una solicitud correcta devolverá un código de estado HTTP 200 OK, mientras que las respuestas fallidas volverán los no-200 estados - una lista detallada de los errores está disponible en el. Autenticación Hay dos maneras de autenticar con la API, la forma fácil (a través de HTTPS) o por las malas (a través de HTTP normal utilizando OAuth). Si está desarrollando una integración diseñado para trabajar con cualquier tienda WooCommerce, que necesita para apoyar esquemas de autenticación, ya que no puede garantizar que todas las tiendas se han habilitado SSL. El índice API de punto final indicará si el sitio es compatible con SSL. Con esto en mente, entra en tu wp-admin y vaya a su perfil de usuario para generar su APIllaves. Debería ver algo como esto: Claves heredan los permisos del usuario que los genera, por lo que si le gustaría tener un control más granular sobre los permisos puede crear un nuevo usuario específicamente para la API. Sólo tiene que utilizar a través de HTTPS, proporcionando la clave de consumidor API como el nombre de usuario y el secreto de consumidor API como la contraseña: $ rizo -u consumer_key: consumer_secret Si va a configurar manualmente el encabezado de autorización HTTP, recuerde que debe Base64 codificar las llaves en primer lugar, de este modo: php> $ autorización = base64_encode:; ($ consumer_key '' $ consumer_secret.). A través de HTTP con OAuth autenticación básica HTTP no se pueden utilizar a través de HTTP claro como las teclas son susceptibles de ser interceptados. La API utiliza para asegurar que sus claves de la API no pueden ser interceptados. Este proceso implica la generación de una firma y que incluye con su solicitud. El API genera su propia firma y la compara con la proporcionada. Si coinciden, la petición es autenticada. El proceso para generaresta firma no es difícil, pero se debe seguir exactamente. La mejor manera es utilizar una biblioteca existente en el idioma que prefiera para manejar la autenticación OAuth. Si eres un masoquista y desea generar la firma manualmente, echar un vistazo a lo que se describe cómo generar la firma. La mayoría de los puntos finales de API Parámetros aceptan parámetros opcionales pasados como parámetros de cadena de consulta HTTP, por ejemplo GET / órdenes de estado = completado? -, Pero el parámetro más importante es el parámetro de filtro. Este parámetro se utiliza para el filtrado de la fecha, la búsqueda y la paginación. Ver la lista completa, junto con ejemplos, en el. API Índice Índice La API proporciona información acerca de la tienda, así como una lista de puntos finales disponibles. No se requiere autenticación para acceder al índice. La propiedad más importante es ssl_enabled que indicará si SSL está disponible o no. Una respuesta de la muestra está disponible en el. Lectura adicional Luego de la serie detallaremos cómo obtener información de la orden, junto concómo actualizar el estado de un pedido. Hasta entonces, aquí está un poco de lectura adicional acerca de la API: - la documentación detallada en el API - una biblioteca simple para acceder a la API en PHP encontrado esto útil? ¡Por favor, comparta!
.
