¿Qué es la API REST de WordPress y cómo se usa?

Probablemente haya oído hablar de la API REST. Tal vez haya escuchado que los usuarios de WordPress se benefician de ello. Pero también te estarás preguntando qué es exactamente una API de WordPress.

Comprender cómo funcionan las API no es tan complicado como parece. Siga leyendo para saber qué es una API, qué es la API REST y cómo puede usar la API REST de WordPress en sus sitios.

¿Qué es una API?

Una interfaz de programa de aplicación (API) es una forma de que dos aplicaciones se “hablen” entre sí. Un sistema hace una solicitud y el otro la cumple. Las solicitudes que acepta un sistema deben incluirse en la API; de lo contrario, la solicitud no se puede cumplir.

Piensa en ello de esta manera. Tal vez tengas mucha hambre y vayas a Waffle House. Pides café, huevos y panqueques. La camarera comienza a escribir su pedido y luego se confunde cuando llega a los panqueques. Waffle House no sirve panqueques. Solo sirven gofres.

Un sistema que solicita panqueques de un menú API que solo sirve gofres se quedará con hambre.

¿Qué es la API REST?

Cuando decimos REST API, estamos hablando de un sistema de restricciones diseñado para Internet. Describe cómo un sitio web puede solicitar información de otro sitio web de manera escalable y uniforme. REST significa Transferencia de Estado Representacional, que fue definido por Roy Fielding en su tesis doctoral.

¿Qué es la API REST de WordPress?

La API REST de WordPress se refiere a las solicitudes realizadas a un sitio web que se ejecuta en WordPress. Si solicitamos una lista de publicaciones o páginas, podemos esperar recibir esa información de la API REST de WordPress. WordPress nunca proporcionará ninguna información que no se haga pública, como borradores de publicaciones o (más importante) contraseñas de usuario.

Esto es fundamental para el Editor de bloques, que intercambia datos dinámicamente con WordPress sin recargar la página. Cada punto final devuelve datos en formato JSON que JavaScript puede leer, o en este caso, bloques.

Tenga en cuenta que la API REST es solo una de las API proporcionadas por WordPress. También existe, por ejemplo, la API de base de datos y la API de metadatos, que los complementos utilizan para interactuar con WordPress en el servidor. Puede obtener más información sobre las API de WordPress en el Codex.

¿Cómo funciona una solicitud de API REST de WordPress?

Hay algunas partes básicas de la API REST, a saber: rutas, puntos finales, solicitudes y respuestas.

Rutas

Una ruta es cómo hacemos referencia a la URL por la que se comunica el sitio web. Una ruta común en WordPress es “/wp-admin”. Aunque no es una ruta de la API REST, es una ruta utilizada por el navegador para acceder al panel de administración de WordPress. Para nuestros propósitos, las rutas de la API REST comienzan con "/wp-json" (siendo JSON el formato estándar de los datos).

Puntos finales

Un punto final es la combinación de una ruta y el tipo de solicitud entrante. Una sola ruta puede conectarse a múltiples puntos finales, ya que existen múltiples tipos de solicitudes. Los tipos de solicitudes comunes incluyen GET (cómo leemos los datos en una ruta) y POST (cómo actualizamos los datos en una ruta).

Solicitudes y respuestas

Cada comunicación con la API REST se intercala entre una solicitud y una respuesta. Un sistema realiza una solicitud a la que responde el otro sistema. La API REST de WordPress incluye objetos útiles para que los complementos accedan a los datos de solicitud (WP_REST_Request) y administren los datos de respuesta (WP_REST_Response) al extender la API REST de WordPress.

Cómo instalar la API REST en WordPress

A partir de la versión 4.7 de WordPress, WordPress incluye la API REST como característica central.

Si está ejecutando una versión anterior, puede instalar el complemento de función json-rest-api. Esto se utilizó para desarrollar la API REST antes de integrarse completamente con el código base de WordPress. Este complemento está técnicamente cerrado, por lo que se recomienda actualizar su versión de WordPress (o tal vez considere el alojamiento administrado de WordPress y siempre estará actualizado).

Ejemplos de la API REST de WordPress

Echa un vistazo al sitio web de GiveWP. Si vas a su blog, podrás ver noticias y publicaciones recientes. Esta ruta representa HTML, que es agradable de ver, pero difícil de interactuar para un programador. En su lugar, las publicaciones se ponen a disposición de los programadores mediante la ruta "/wp-json/wp/v2/posts".

La ruta “/wp-json/wp/v2/posts” nos dice que este es un recurso de WordPress (“/wp”), que esta es la versión 2 (“/v2/”) del recurso, y específicamente que estos son publicaciones (“/publicaciones”). Si aún no lo ha hecho, visite https://givewp.com/wp-json/wp/v2/posts y compare lo que ve con https://givewp.com/blog/. Te daré una pista: ¡es la misma información!

Para ver un ejemplo de cómo se usa la API REST dentro de WordPress, considere el bloque de publicaciones más recientes. Para obtener una lista de publicaciones en WordPress, el sitio tradicionalmente necesitaría hacer una solicitud al servidor y luego volver a mostrar la página completa.

El último bloque de publicaciones puede solicitar solo las publicaciones y luego volver a renderizarse. Lo hace usando la API REST. Y puede hacerlo varias veces para sondear nuevas publicaciones, sin volver a renderizar la página completa. Esto es especialmente útil cuando considera la edición completa del sitio en la que se utilizan bloques para editar y mostrar los componentes de la página.

Cada componente individual puede solicitar los datos que necesita (incluida la búsqueda de actualizaciones) y luego volver a representar solo lo que ha cambiado.

ahora ya sabes

Ahora que conoce el propósito y la estructura de una API REST de WordPress, explore para ver qué puede encontrar por su cuenta. Para obtener un resumen completo sobre el uso y la ampliación de la API REST de WordPress, consulte el Manual de la API REST.

Recuerda: si alguien te pregunta sobre las API, no puedes pedir panqueques en Waffle House.

Mientras ajusta su sitio, no olvide que los grandes sitios necesitan un gran alojamiento. Obtienes todo eso con Managed WordPress by Nexcess. Con velocidades potentes, opciones de escalabilidad y soporte excepcional, puede confiar en Nexcess para potenciar su sitio de WordPress.

Venga a ver por qué mejor está integrado con Nexcess. Consulte nuestros planes de alojamiento totalmente administrados de WordPress hoy.

Recursos relacionados de WordPress

• WordPress.com frente a WordPress.org
• 5 técnicas avanzadas para acelerar su sitio de WordPress
• ¿Qué es el alojamiento de WordPress?
• La guía esencial para los complementos de WordPress
• Cómo elegir un servidor web: qué buscar y qué evitar