WordPress

Guía para principiantes de la API REST de WordPress

wordpress-api-rest

Casi todos los profesionales que trabajan con WordPress ya han oído hablar de la API REST, gracias a su incorporación al núcleo a finales de 2015. Sin embargo, solo los desarrolladores avanzados se han tomado el tiempo para aprender cuán poderosa puede ser esta nueva característica.

La API REST de WordPress presenta un gran avance en cada instalación actualizada, al proporcionar una API incorporada que se puede integrar con temas, aplicaciones móviles y más. En otras palabras, permite a los desarrolladores separar la interfaz frontal de la administración de datos, permitiendo que cualquier aplicación interactúe con WordPress. Aprender a trabajar con esta herramienta puede abrir las puertas a posibilidades casi infinitas para extender tu sitio web de WordPress.

En este artículo, te presentaremos el proyecto API REST de WordPress, te explicaremos por qué es tan importante y luego te ofreceremos información sobre cómo usarlo. No hay tiempo que perder, ¡así que empecemos!

Presentamos la API REST de WordPress

Página de inicio del proyecto WP REST API

El proyecto API de Transferencia de Estado Representacional (REST, por sus siglas en inglés) ​​de WordPress afirma que WordPress está haciendo avances para convertirse en un marco de aplicación completamente desarrollado. Su misma existencia respalda esta afirmación, ya que agrega una API REST estándar de la industria al núcleo de WordPress.

El proyecto fue cargado por primera vez en GitHub para su desarrollo en junio de 2013 por Ryan McCue y Rachel Baker. El plugin API REST independiente se integró al núcleo de WordPress en diciembre de 2015, después de obtener un gran apoyo público y atraer a casi 100 colaboradores para trabajar en el perfeccionamiento de sus capacidades.

Desde su debut en el núcleo de WordPress, la API REST ha demostrado tener muchos usos. Aquí hay algunas maneras en que puedes aprovecharlo en tus proyectos, todas salidas de ejemplos reales:

  1. Event Espresso utiliza la API REST para proporcionar acceso de desarrollador a su infraestructura interna, lo que hace posible desarrollar aplicaciones basadas en sus servicios.
  2. Simmer permite a los desarrolladores acceder a la API para extender su funcionalidad de recetas a aplicaciones móviles completamente desarrolladas o a temas personalizados.
  3. JoinIn potencia su propio widget “incrustable” utilizando la API REST, proporcionándole los datos apropiados donde sea que se muestre.

Esta es solo la punta del iceberg cuando se trata de los usos innovadores de la API REST. Sin embargo, veamos ahora cómo funciona la API REST.

Cómo funciona la API REST de WordPress

En breve, la API REST funciona manipulando datos textuales de un lugar a otro sin acceso directo a una base de datos o interfaz de usuario. Hay muchos tipos de interfaces de programación de aplicaciones (API), pero REST se destaca como un estándar moderno.

Las API REST se entregan a través de puntos finales de HTTP, utilizando el formato de JavaScript Object Notation (JSON). En términos más simples, estas tecnologías proporcionan acceso a la API usando direcciones web únicas para entregar datos que se comportan como objetos de JavaScript.

Si nunca antes has trabajado con JavaScript o su notación de objetos, una buena idea es comenzar por aprender los principios básicos de JSON. Cuando te sientas más cómodo con el concepto de la API REST, hablaremos sobre el gran impacto que tendrá para todos los desarrolladores de WordPress.

Por qué la API REST de WordPress es importante para los desarrolladores

Manual de API REST de WordPress

La API REST de WordPress es un conector universal desde cualquier instalación de WordPress a cualquier aplicación en un servidor web o sistema operativo del usuario. En última instancia, esto significa que el único límite para lo que se puede construir con WordPress ahora es nuestra imaginación. Puedes construir cualquier aplicación, código con cualquier plataforma o lenguaje, y ​​usar WordPress para manejar los datos a través de la API REST. Las implicaciones de esto son enormes gracias a la comunidad abierta y amigable de WordPress.

Además, dado que la API REST se basa en JavaScript, este enfoque creciente en la API indica un cambio en cuáles son los lenguajes de programación más relevantes para aprender. Pronto nos podríamos encontrar con que JavaScript del lado del servidor es el nuevo PHP. Esto ya se puede ver en el nuevo software de WordPress.com, Calypso, que se ejecuta completamente en JavaScript y la API REST.

Al estandarizar la forma en que las aplicaciones (incluido el núcleo de WordPress) interactúan con los datos de WordPress, el desarrollo de WordPress será más simple e intuitivo. Además, será más fácil integrarse con plataformas de terceros.

Sin embargo, el período de transición puede ser un poco difícil, por eso es importante comenzar a aprender a usar esta tecnología desde ahora. ¡Ahora ya puedes dar los primeros pasos para empezar a usar la API REST en tus projectos!

5 pasos para comenzar con la API REST de WordPress

Como vimos anteriormente, la API REST se puede usar con cualquier aplicación o lenguaje de programación que pueda llamar a un punto final HTTP (que es la mayoría). Por lo tanto, nos enfocaremos en usar la línea de comando para ejecutar solicitudes de API REST, porque es el método más simple y presenta mínimas oportunidades para que los errores programáticos interrumpan tu aprendizaje.

Para hacerlo, abre el programa de Interfaz de Línea de Comandos (CLI) en tu computadora: Terminal en macOS y Linux, y Símbolo del sistema en Windows. CLI te permite interactuar directamente con la API REST sin necesidad de escribir scripts adicionales para solicitar y procesar la información. Cualquier solicitud que realices en la CLI se puede escribir en PHP, JavaScript y otros lenguajes, pero el método variará para cada uno. Dar comandos en la CLI es sencillo, simplemente escribe el comando deseado y presiona ENTER en tu teclado.

También te recomendamos configurar un sitio de prueba o probar localmente, y no completar este tutorial en un sitio publicado. Finalmente, el único requisito adicional es que tu sitio de WordPress se ejecute en la versión 4.4 o superior. Cuando estés listo, ¡empecemos!

Paso 1: Familiarízate con los conceptos clave de la API REST

Antes de comenzar, es una buena idea familiarizarse con todas las partes móviles de la API REST. Hay cinco conceptos y términos clave con los que te deberías familiarizar. Repasemos ahora:

  1. ‘Rutas’ y ‘Puntos finales’. Este es el aspecto más importante de la API REST. Las rutas te ayudan a navegar a través de los puntos finales, que son cuando un método HTTP específico (por ejemplo, un conjunto de datos estáticos o una acción) está conectado a una ruta específica. Por ejemplo, /wp-json/ es una ruta configurada como punto final, diseñada para mostrarnos las rutas disponibles.
  2. Peticiones. Estas se crean activando los puntos finales correctos y transmitiendo los datos.
  3. Respuestas En resumen, estas proporcionan los datos que solicitaste o devuelven un error que te permite saber qué fue lo que salió mal.
  4. Esquemas. Estos son los modelos con que se dan las respuestas, así siempre sabrás exactamente dónde buscar los datos correctos.
  5. Clases de controlador. En términos simples, te permiten construir tus propias rutas y puntos finales. Por ahora, no debes preocuparte por estos, aunque serán útiles más adelante.

Cuando comprendas estos cinco conceptos, puedes comenzar a profundizar en la API REST en sí misma, comenzando con sus puntos finales.

Paso 2: Conoce los puntos finales más útiles de la API REST

La API REST de WordPress ofrece un manual de referencia cargado con todos los puntos finales que te serán más útiles. Primero, querrás saber cómo construir una llamada HTTP a la API REST. La base de toda llamada de la API REST de WordPress es la siguiente, reemplazando el marcador de posición tudominio.com con el tuyo:

http://tudominio.com/wp-json/

Puedes probar la conexión ejecutando el comando curl en tu CLI usando tu propia URL:

curl -X OPTIONS -i http://tudominio.com/wp-json/

Deberías ver un mensaje de HTTP exitoso. A continuación, puedes repetir este comando utilizando varios de los puntos finales principales. Esta vez, simplemente usaremos la versión GET de curl.

Para obtener una lista JSON de tus publicaciones de WordPress, puedes usar lo siguiente:

curl -X GET -i http://tudominio.com/wp-json/wp/v2/posts

Alternativamente, intenta esto para ver todas tus páginas de WordPress existentes:

curl -X GET -i http://tudominio.com/wp-json/wp/v2/pages

Puedes experimentar con cada uno de estos puntos finales (¡y más!) en la CLI para revisar qué tipo de respuesta se devuelve para cada uno.

Paso 3: Aprende los conceptos básicos de autenticación de la API REST

Ahora vamos a aprender sobre autenticación. Algunas acciones y datos dentro de la API REST son públicos, mientras que otros requieren que inicies sesión como administrador. Sin embargo, esta es una API REST, por lo tanto no hay ningún lugar para iniciar sesión. En vez de eso, puedes autenticarte al hacer cualquier llamada que requiera acceso administrativo, como ver contenido no publicado o actualizar una publicación.

Comienza por instalar el plugin Basic Auth para la API REST de WordPress. Es un plugin sencillo solo para desarrolladores que te ayudará a aprender la API REST rápidamente y no está destinado a sitios activos. Sin embargo, el proceso de instalación es como cualquier otro plugin.

Una vez instalado Basic Auth, podrás autenticarte a través de la CLI con el flag user. Aquí hay un ejemplo de cómo aplicar el método de autenticación user, usando curl para ver el contenido no publicado:

curl -X GET --user username:password -i http://tudominio.com/wp-json/wp/v2/posts?status=draft

Se requerirá autenticación para cualquier cosa que no sea visualizar información pública. Cuando estés familiarizado con la autenticación básica, puedes explorar las otras opciones recomendadas por la documentación API REST para tu código de producción.

Paso 4: Selecciona tu primera publicación de WordPress con la API REST

Cuando hayas entendido cómo hacer llamadas básicas a la API REST usando curl, intenta seleccionar una publicación específica. Primero, enumera todas tus publicaciones como lo hicimos anteriormente:

curl -X GET -i http://tudominio.com/wp-json/wp/v2/posts

Luego, busca el ID de una publicación que quieras actualizar. Agrega este ID al final de tu consulta para seleccionar solo esa publicación individual:

curl -X GET -i http://tudominio.com/wp-json/wp/v2/posts/<ID>

Puedes usar esto para seleccionar un ID determinado para cualquier punto final de la API REST, ya sea que quieras ver una publicación, página o taxonomía.

Paso 5: Actualiza tu primera publicación de WordPress con la API REST

Finalmente, intentemos enviar una actualización a tu publicación seleccionada. En lugar de usar los comandos OPTION o GET, esta vez queremos enviar un cambio con el comando POST. GET se usa para leer datos, mientras que POST se usa para enviarlos.

Cambiemos el título de tu publicación, enviando una solicitud POST junto con tus credenciales de autenticación. Los nuevos cambios se compartirán usando el flag d al final de tu comando. Pasarás un objeto JavaScript personalizado configurando la variable title con un valor personalizado, como Mi nuevo título, como se ve en el siguiente código de ejemplo:

curl -X POST --user username:password http://tudominio.com/wp-json/wp/v2/posts/<ID> -d '{"title":"Mi nuevo titulo"}'

Asegúrate de reemplazar el nombre de usuario, la contraseña, el ID de la publicación y el título con tu propia información. Puedes volver a seleccionar la publicación individual para verificar los nuevos cambios:

curl -X GET -i http://tudominio.com/wp-json/wp/v2/posts/<ID>

¡Felicitaciones! Acabas de realizar tus primeras ediciones administrativas con la API REST de WordPress. Por supuesto, este tutorial básico apenas araña la superficie de lo que la API REST puede hacer, ¡pero en este punto el cielo es el límite!

Conclusión

La API REST de WordPress es una nueva y poderosa adición al núcleo de WordPress, y pocos desarrolladores han comenzado a arañar la superficie de sus capacidades. En consecuencia, embarcarse ahora y aprender a trabajar con ella puede hacerte más valioso como desarrollador, y te permitirá crear aplicaciones utilizando WordPress como marco.

En resumen, estos son nuestros cinco pasos para aprender a interactuar con la API REST de WordPress:

  1. Familiarízate con los conceptos clave de la API REST.
  2. Conoce los puntos finales más útiles de la API REST.
  3. Aprende los conceptos básicos de autenticación de la API REST.
  4. Selecciona tu primera publicación de WordPress con la API REST.
  5. Actualiza una publicación de WordPress con la API REST.

¿Qué preguntas tienes sobre la API REST de WordPress? ¡Cuéntanos en la sección de comentarios!

1 Comentario

Dale clic aquí para dejar un comentario

Únete a cientos de suscriptores en todo el mundo

y consigue increíbles tutoriales y descuentos en tu email

Please wait...

¡Gracias por registrarte!

Comienza a ahorrar hoy mismo!

Alojamientos con todo incluido y nombre de dominio po

MX$45
00
/mes