Guía de Explicación de WordPress REST API

La interfaz de programación de aplicaciones (WordPress REST API) en WordPress es una característica integrada como complemento personalizado en las versiones modernas de WordPress. Esta característica ayuda a un sitio de WordPress a interactuar con cualquier aplicación externa, ya sea una aplicación web, una aplicación móvil u otra, facilitando el proceso de compartir datos del sitio con estas aplicaciones fácilmente. En el artículo de hoy te explicaremos todos los detalles sobre la característica REST API, los términos más importantes asociados con ella y cómo aprovecharlo en tu sitio, además de mostrarte de manera práctica cómo usarlo para obtener y editar artículos del sitio fácilmente, junto con una explicación de cómo activar o desactivar esta característica en tu sitio si deseas no usarla.

Contenido del artículo ¿Qué significa API? ¿Qué es la característica WordPress REST API? Importancia de WordPress REST API Uso del complemento WordPress REST API Conceptos iniciales Obtención de datos del sitio mediante interfaz de programación de aplicaciones Actualización de datos del sitio mediante interfaz de programación de aplicaciones Cómo eliminar datos del sitio mediante interfaz de programación de aplicaciones Activación de WordPress REST API en versiones antiguas de WordPress Desactivación de WordPress REST API Aplicaciones prácticas del uso del complemento REST API 1- El editor avanzado Gutenberg 2- Plataforma UsTwo 3- Sitio US TODAY ¿Qué significa API? El término API es una abreviatura de las siguientes palabras (Application Programming Interface), es decir, interfaz de programación de aplicaciones, y en general significa crear un punto de conexión entre una aplicación o un sistema de programación específico y tú como programador de backend (Backend Developer). Donde un programador de interfaz backend puede beneficiarse de los servicios y resultados de esta aplicación o sistema de programación en un sitio web o aplicación móvil sin necesidad de reconstruirlo desde cero. Por ejemplo, si agregaste Google Maps a tu sitio de WordPress, en ese caso estás utilizando la API de Google Maps para conectar tu sitio de WordPress con Google Maps.

De la misma manera, cuando se agrega el botón de Me gusta de Facebook a una página en tu sitio de WordPress, esto se hace conectando la interfaz de programación de aplicaciones de Facebook a tu sitio. De esta forma habilitas esa página web para usar la interfaz de programación de aplicaciones para recibir datos (botón de Me gusta) y enviar datos (solicitud de Me gusta).

¿Qué es la característica WordPress REST API?

Las aplicaciones REST API son una abreviatura de Representational State Transfer y son un tipo o estándar de interfaz de programación de aplicaciones que sigue un enfoque de estructuración de programación que define cómo se comunican entre sí los servicios web a través del protocolo de transferencia de hipertexto (HTTP). Hay muchos tipos de interfaces de programación de aplicaciones (API), pero REST se considera la más famosa y moderna, y funciona procesando datos de texto de aplicaciones externas sin necesidad de acceso directo a la base de datos de estas aplicaciones. La interfaz de programación de aplicaciones WordPress REST API se utiliza en WordPress para ayudar a los desarrolladores de WordPress a conectar su sitio de WordPress con otros sitios web externos, aplicaciones web o aplicaciones móviles, también ayuda a los desarrolladores a acceder a la base de datos del sitio, recuperar datos de ella y agregar datos a ella.

A través de esta característica, podrás obtener la información que desees de la base de datos de tu sitio de WordPress en formato JavaScript Object Notation (JSON). Es un lenguaje diseñado específicamente para enviar, recibir y almacenar datos. Almacena datos en pares (clave y valor), después puedes mostrar estos datos en cualquier otro entorno de programación, incluso si ese entorno no usa el lenguaje PHP en el que se basa WordPress.

Por ejemplo, si deseas crear una aplicación móvil para tu teléfono que no dependa de WebView, que generalmente muestra una versión idéntica de todos los datos de tu sitio web dentro de un marco iframe, y deseas extraer solo algunos datos específicos del sitio como (artículos, medios, páginas, categorías u otros datos específicos), en este caso necesitas usar REST API que organiza estos datos y los pone a disposición del desarrollador de aplicaciones móviles para que pueda reutilizarlos automáticamente en la aplicación. Importancia de WordPress REST API REST API está integrada en las versiones modernas de WordPress (4.7 en adelante) implícitamente como un complemento REST API activado automáticamente para permitir a los desarrolladores compartir todos los datos de su sitio de WordPress con todas las aplicaciones web externas o aplicaciones móviles, facilitando la programación de cualquier aplicación que dependa principalmente de datos de su sitio de WordPress, sin ella necesitarías programar una API para tu sitio desde cero, lo cual es muy costoso. Además, el complemento te ayuda a recibir datos de terceros también dentro de tu sitio, no solo enviarlos, por ejemplo, en sitios de WooCommerce, el complemento recibe pedidos de cualquier aplicación externa y los guarda en tu sitio de manera simplificada, también devuelve los datos del pedido a la aplicación para que se muestre al cliente.

De manera similar, esta característica es muy importante en todos los sitios de WordPress y es imprescindible en cualquier sitio, incluso si no necesitas crear ninguna aplicación externa, ya que el complemento REST API en las versiones modernas de WordPress funciona de manera integrada y es necesario para que funcionen algunas características como el editor de bloques Gutenberg. Esta característica permitió que el sistema WordPress evolucionara de ser simplemente una plataforma para crear sitios web a convertirse en un marco de trabajo de aplicaciones completo. Permite a los desarrolladores usarlo para crear aplicaciones móviles y aplicaciones web con mucha facilidad.

Lee también: Explicación de las Aplicaciones Web Progresivas (PWAs), sus características y cómo crearlas En los párrafos siguientes te explicaremos cómo aprovechar WordPress REST API para obtener datos específicos de cualquier sitio de WordPress con ejemplos prácticos. Uso del complemento WordPress REST API Al principio, antes de explicar el complemento, debes conocer algunos conceptos básicos que cualquier desarrollador que use esta tecnología necesita entender su significado: Conceptos iniciales Ruta (Route): Es el enlace que te permite acceder al sitio con diferentes credenciales como HTTP o Https. Punto final (EndPoint): Es la conexión que se establece entre HTTP y la Ruta, para acceder a un punto final, debes usar una ruta que tome la forma de una URL normal. Como ejemplo, la siguiente ruta http://yourdomain.com/wp-json/ que devuelve todo el contenido y metadatos de tu sitio en formato JSON.

Solicitud (Request): Es un comando emitido por WP-Rest_Request, se utiliza para obtener y almacenar información de la solicitud actual. Respuesta (Response): Proporciona los datos que se solicitaron con una solicitud Request, y en caso de no estar disponibles, devuelve un mensaje de error explicando la razón, para que puedas corregirlo. Esquema (Schema): Te permite convertir todas las entradas y propiedades en listas que REST API puede aceptar y dirigir para usarlas.

Clases de controlador (Controller Classes): Es el lugar donde puedes administrar todos los aspectos del complemento Rest API. Obtención de datos del sitio mediante interfaz de programación de aplicaciones En esta sección explicaremos cómo obtener datos del sitio usando Rest API, al principio debes saber que toda tu interacción será con el dominio de tu sitio a través de la ruta del archivo wp-json en la siguiente página http://yourdomain.com/wp-json/ También debes saber que hay tres solicitudes JSON básicas que usarás con REST API (solicitud GET para recuperar datos de la interfaz de programación de aplicaciones, solicitud POST que te permite enviar información nueva a WordPress y solicitud DELETE para eliminar datos) Para ejecutar estas solicitudes, sigue estos pasos: 1- Para acceder a la interfaz de programación de aplicaciones WP-REST API, primero necesitarás acceder a tu sitio a través de la línea de comandos (Command line), esto se puede lograr en sitios de WordPress instalando la herramienta WP-CLI, que es una herramienta de línea de comandos diseñada para desarrolladores para permitirles administrar tareas en WordPress. Para instalar WP-CLI, asegúrate de que tu cuenta de hosting admita acceso SSH, ya que la mayoría de los proveedores de hosting compartido no te dan acceso SSH.

2- Después de instalar la interfaz de línea de comandos y conectarte a tu sitio a través de ella, primero debes probar la conexión y asegurarte de poder obtener datos de la página solicitada, escribiendo el siguiente comando: curl -X OPTIONS -i http://yourdomain.com/wp-json/ 4. Verás el siguiente mensaje que indica una conexión exitosa: HTTP/1.1 200 OK Date: Wed, 23 Oct 2021 19:51:41 GMT Server: Apache/2.4.29 X-Robots-Tag: noindex Link: ; rel="https://api.w.org/" X-Content-Type-Options: nosniff Access-Control-Expose-Headers: X-WP-Total, X-WP-TotalPages Access-Control-Allow-Headers: Authorization, Content-Type Allow: GET Transfer-Encoding: chunked Content-Type: application/json; charset=UTF-8 Después de una conexión exitosa, puedes obtener cualquier contenido del sitio. Escriba la siguiente solicitud GET al principio para obtener una respuesta en JSON que le muestre las rutas disponibles desde las que puede obtener datos y los puntos finales disponibles dentro de cada ruta.

curl -X GET -i http://yourdomain.com/wp-json El complemento se destaca por permitir obtener contenido específico solo de páginas o artículos, en caso de que desees obtener contenido solo de artículos publicados en tu sitio, usa la siguiente solicitud: curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts Puedes ver resultados similares a los que obtendrás al ejecutar esta solicitud si vas al siguiente enlace en el sitio de WordPress en árabe https://wpar.net//wp-json/wp/v2/posts donde obtendrás mucha información sobre todos los artículos del sitio. Es posible que la información no te parezca clara al principio, pero contiene mucha información importante en formato JSON como el ID, nombre, fecha y textos de los artículos publicados en nuestro sitio. Luego puedes usar esta información en una de las aplicaciones, por ejemplo, y mostrarla de una manera clara usando tu diseño personalizado.

Pero si deseas obtener contenido solo de las páginas del sitio, usa la siguiente línea: curl -X GET -i http://yourdomain.com/wp-json/wp/v2/pages También puedes cambiar los datos que se obtendrán cambiando los parámetros pasados al enlace en el código anterior. Por ejemplo, si agregas per_page = 5 como se muestra a continuación https://yourdomain.com/wp-json/wp/v2/posts?per_page=5 puedes obtener datos de solo 5 artículos. Y así simplemente, todo lo que tienes que hacer es cambiar la ruta pasada y obtener la información que deseas del sitio, la siguiente fase es usar esta información de otras plataformas para mostrarla apropiadamente (normalmente esta información se analiza usando el lenguaje de programación JavaScript y los datos se generan en un formato fácil de leer usando HTML) Actualización de datos del sitio mediante interfaz de programación de aplicaciones REST API se destaca por ser muy fácil de usar para editar el contenido de un artículo específico, primero debes identificarlo, para identificar contenido específico para editarlo o actualizarlo, escribe primero la siguiente línea: curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts Luego encuentra el ID del artículo que deseas actualizar y agrégalo en lugar de ID en la siguiente línea: curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts/ Ahora puedes, por ejemplo, cambiar el título del artículo, usando la siguiente solicitud POST cambiando el valor del título con el nuevo título pasándolo como parámetro de la siguiente manera: curl -X POST --user username:password http://yourdomain.com/wp-json/wp/v2/posts/PostID -d '{"title":"My New Title"}' Hay muchos otros parámetros que puedes usar para hacer cambios en un artículo.

Por ejemplo, puedes cambiar la categoría o clasificación del artículo o cambiar su estado de publicación o cambiar todo su contenido. Cómo eliminar datos del sitio mediante interfaz de programación de aplicaciones Ahora te mostraremos ejemplos de cómo eliminar datos del sitio usando la interfaz de programación de aplicaciones REST. Por ejemplo, para eliminar un usuario del sitio.

Puedes usar la siguiente solicitud DELETE para eliminar el usuario que tiene ID = 10: curl -X DELETE http://example.com/wp-json/wp/v2/users/10 Esto resultará en la eliminación del usuario especificado del sitio. También puedes usar posteriormente parámetros adicionales para reasignar los artículos de este usuario a otro usuario según su ID de usuario o eliminar permanentemente sus artículos del sitio.

Nota: A veces al ejecutar algunos comandos

(como comandos para actualizar o eliminar contenido) es posible que se te pida que inicies sesión como administrador. Para poder hacer esto, debes instalar y activar el complemento REST API Basic Auth en tu sitio. Después de activar el complemento, abre la interfaz de línea de comandos CLI y escriba el siguiente comando para poder hacer una solicitud a REST API con permisos de administrador, reemplazando el nombre de usuario y la contraseña con los de tu cuenta de administrador del sitio.

curl -X GET --user username:password -i http://yourdomain.com/wp-json/wp/v2/posts?status=draft Después obtén cualquier dato que desees de dentro de la ruta wp-json como explicamos. Y si deseas ver todos los enlaces y datos a los que puedes acceder en tu sitio, te recomendamos que vayas al siguiente enlace Reference handbook. De esta manera, te hemos mostrado algunos ejemplos prácticos de cómo obtener datos a través de REST API, todo lo que tienes que hacer es aprender la tecnología RESET API y aprender los conceptos básicos de JSON para adquirir las habilidades básicas para trabajar con los datos que tu sitio proporciona.

Si utilizas una versión antigua de WordPress y deseas aprovechar esta tecnología, puedes simplemente activar el complemento REST API en tu sitio de la siguiente manera: Activar WordPress REST API en versiones antiguas de WordPress. Como se mencionó al inicio del artículo, si utilizas versiones antiguas de WordPress (versión 4.7 o anteriores), el complemento REST API no vendrá activado con el sistema WordPress de forma predeterminada y, en este caso, deberás instalar el complemento REST API manualmente para poder utilizarlo y aprovechar sus características. Nota: Puedes conocer la versión de WordPress de tu sitio dirigiéndote al final de la página principal del administrador, donde verás la frase "Gracias por usar WordPress" seguida de "Versión xxx", donde xxx representa el número de versión de WordPress utilizada en tu sitio. Para instalar este complemento en un sitio WordPress con una versión antigua.

Descarga el complemento desde el siguiente enlace: Complemento REST API. Carga el complemento a tu sitio a través de: Complementos > Añadir nuevo > Subir complemento. Haz clic en el botón para activar el complemento y de esta manera se activa correctamente. Después de esto no necesitarás ajustar nada, ya que el complemento funciona automáticamente. De esta forma habrás garantizado la activación del complemento en tu sitio. Con la advertencia de que si instalas complementos de seguridad en tu sitio, estos pueden desactivar la característica WP REST API habilitada en tu sitio, por lo que asegúrate de permitir su uso en tu sitio. Desactivar WordPress REST API. A veces, el complemento REST API es utilizado incorrectamente por desarrolladores desconocidos para crear una aplicación o sitio web que depende principalmente de datos obtenidos de tu sitio, u de otra manera.

Por lo tanto, si no utilizas las características de REST API en tu sitio directamente ni las necesitarás posteriormente, es posible que debas desactivarlas, especialmente si trabajas con versiones recientes de WordPress que tienen esta característica integrada. Para hacer esto, debes instalar y activar el complemento Disable WP REST API en tu sitio. También puedes desactivar esta característica manualmente a través del archivo Function.php agregando un código dentro de él.

Ingresando al editor de plantillas, selecciona la plantilla utilizada y luego encontrarás el archivo functions.php al principio de los archivos de la plantilla. Luego, editándolo y añadiendo el siguiente código. add_filter( 'json_enabled', '__return_false' ); add_filter( 'json_jsonp_enabled', '__return_false' ); Aplicaciones prácticas del uso del complemento REST API. A continuación, mencionamos algunos ejemplos de aplicaciones prácticas creadas utilizando el complemento REST API integrado en WordPress. 1- Editor avanzado Gutenberg. Esta aplicación es una de las más famosas en relación con la característica REST API, pero ¿cómo es posible si ya está presente en tu sitio?

La respuesta a esta pregunta es que el editor avanzado Gutenberg utiliza el complemento REST API implícitamente para acceder a la base de datos y crear bloques. 2- Plataforma UsTwo. UsTwo es una empresa digital cuyo sitio web fue creado basándose en el complemento REST API como una aplicación de página única. La interfaz frontend fue programada en React, mientras que el backend está construido sobre WordPress con algunas modificaciones para adaptarse a los usos del sitio y depende completamente de la API REST. 3- Sitio US TODAY. Parte del famoso sitio de noticias USA Today se basó en la API REST para compartir el contenido del sitio en otras plataformas como Facebook Instant Articles, Apple News y otros servicios de noticias que ayudan a la propagación de noticias en la web. Conclusión. En este artículo, aprendimos sobre el concepto de interfaz de programación de aplicaciones (API), que es una función que vincula diferentes sistemas entre sí, y explicamos el mecanismo de funcionamiento de la interfaz REST API en WordPress y sus características más importantes. También incluimos algunos ejemplos prácticos que te permiten administrar el contenido de tu sitio a través de ellos.

Te recomendamos, como desarrollador de WordPress, que profundices más en la tecnología REST API y aprendas el formato JSON para poder compartir datos de sitios WordPress con cualquier parte que desees, y domines la tarea de construir aplicaciones externas basadas en el contenido de sitios WordPress fácilmente.