La guía completa de los fundamentos de API REST de WordPress |
La API REST de WP está en proceso de cambio de WP. Es posible que no lo haya apreciado, puesto que gran parte de ella está bajo el capó, pero las implicaciones de API REST marcan una gran diferencia para el futuro de Wordpress, tanto en términos de su base de código como de sus usos.
Si no ha trabajado con API REST de WP, es posible que se pregunte qué es. Así que vamos a empezar mirando lo que es API de REST.
API REST de WordPress es una interfaz quepueden emplear para acceder a WordPress desde fuera de la propia instalación de WordPress. Se accede a él usando JavaScript, lo que quiere decir que se puede emplear para crear sitios web y aplicaciones interactivas.
REST significa Representational State Transfer y API significa Application Programming Interfaz. Echemos una ojeada a lo que significa cada uno de ellos.
Una Interfaz de Programación de Aplicaciones, o API, secomo:
«Una interfaz o protocolo de comunicación entre un usuario y un servidor para simplificar la construcción de software del lado del cliente del servicio.»
Si no está familiarizado con las API, posiblemente eso no le asista mucho. En resumen, una API es un conjunto de código que deja a un sistema interactuar (o «interfaz») con otro. Si alguna vez ha, ha empleado API de Google Maps, que deja que su lugar de WP interactúe con Google Maps.
Estos sistemas no precisan estar totalmente separados. WordPress ya tiene múltiples, para cosas como, configuraciones y. Estos pueden ser usados por los desarrolladores de plugins y temas para interaccionar con el núcleo de WP y hacer que las cosas sucedan (como crear atajos y añadir pantallas de configuración al administrador de Wordpress).
La diferencia con la API de REST es que permite que los sistemas fuera de la propia instalación de WordPress interactúen con WP, que es donde entra en juego la una parte de REST.
Representational State Transfer, o REST, da estándares que los sistemas web pueden utilizar para interaccionar entre sí. Sin REST, dos sistemas no podrían comprenderse entre sí y, por tanto, enviar datos de un lado a otro.
Para que una aplicación sea, debe cumplir con 5 principios:
Todas estas limitaciones se refieren a páginas web y aplicaciones y rigen la forma en que una aplicación puede interaccionar con la API.
La combinación de REST y API significa que API REST de WordPress es un conjunto de código diseñado para hacer posible que otros sistemas interactúen con WordPress y que está construido de una manera que asegura que estos sistemas se entiendan entre sí.
Esto quiere decir que un sitio de terceros o bien una aplicación móvil, por ejemplo, puede acceder a la, conseguir datos de ella y añadir datos a exactamente la misma.
Sin embargo, hay una serie de implicaciones y usos para esto.
API REST de WordPress fue desarrollada como respuesta a los cambios en la manera en que se desarrollan los sitios y las aplicaciones y a la necesidad de abrir WordPress más extensamente.
API REST de WordPresscomo una parte del núcleo en la versión cuarenta y siete en el último mes del año de dos mil dieciseis, mas ya estaba libre como un plugin ya antes de esa fecha.
Está diseñado para soportar una amplia gama de aplicaciones construidas sobre Wordpress y para convertir WP de una una plataforma de aplicaciones.
Es usado ampliamente por, cuya interfaz basada en JavaScript emplea API REST para interaccionar con la base de datos de Wordpress. También es utilizado por la, que se convirtió en parte del núcleo en 2019.
API REST amplía la gama de aplicaciones para las que se puede usar Wordpress. Mientras que un sistema de gestión de contenidos destaca en la ejecución de un sitio complejo, una plataforma de aplicaciones también se puede emplear para impulsar aplicaciones de una sola página basadas en web o SPAs (si alguna vez ha usado, ha empleado uno de ellos).
En estos, el contenido se actualiza cuando el usuario toma acción, en vez de cargar nuevas páginas. Debido a que utiliza JavaScript (un lenguaje del lado del usuario) en lugar de(un lenguaje del lado del servidor), puede hacer que las cosas sucedan en el navegador del usuario sin mandar constantemente solicitudes al servidor.
Si es un usuario y/o desarrollador que trabaja con WordPress, API REST tiene una serie de implicaciones.
Para los usuarios, estos incluyen:
Para los desarrolladores, hay implicaciones y posibilidades más amplias:
Con el tiempo, API REST de Wordpress significará que la mayor parte del núcleo de WordPress se escribirá en JavaScript y no en PHP. Si es un desarrollador de Wordpress, esto quiere decir que necesitará aprender JavaScript.
¿Cómo se accede a API REST de Wordpress?
Para acceder a WP-API REST, deberá acceder a su lugar a través de la línea de comandos. Con WP, esto lleva por nombre. Usted no hace nada de esto a través de sus pantallas de administración o accediendo de forma directa al código de su sitio.
Echemos un vistazo a cómo empezar.
WP-CLI es la interfaz de línea de comandos de WordPress. Le deja acceder y trabajar con Wordpress a través de la interfaz de línea de comandos (CLI) de su computador. WP-CLI está preinstalado con todos y cada uno de los planes de alojamiento de Kinsta.
Para acceder a la CLI, abra Terminal en un Mac o en Linux, o bien Símbolo del sistema en Windows.
Terminal on Mac
Para acceder a un sitio recóndito, necesitapara acceder a él a través de WP-CLI (¿No puedes conectarte por SSH? Aprende a).
Para acceder a un, basta con emplear la estructura de directorios correcta desde la línea de comandos. Es una gran idea experimentar con API REST en un sitio de pruebas local antes de probarla en un lugar en vivo.
Necesitará acceder específicamente a API REST de su lugar, de esta manera:
A continuación, puede añadir elementos para acceder a ciertos tipos de datos, que analizaremos con más detalle dentro de poco. Estos elementos se denominan puntos finales.
Una vez que haya accedido a su sitio, es posible que deba pasar por un proceso de autenticación. Ciertos endpoints son públicos y no requieren autenticación, mientras que otros sí.
No estáaquí: API REST hace las cosas de forma un poco diferente.
Para poder autentificar su sitio a través de WP-CLI, necesitará instalar un plugin de autenticación. Para las instalaciones de desarrollo, el pluginhace el trabajo y es fácil de emplear.
Sin embargo, para sitios en vivo, debería utilizar una forma más robusta de autenticación como el complemento, que emplea JSON Web Token y es más seguro.
A continuación, puede emplear la línea de comandos para acceder a los datos y también incluir la autenticación.
El siguiente ejemplo usa
curlpara probar la conexión con WP. Se emitirá una lista de borradores de puestos.
Los bocetos de mensajes no son información pública, con lo que necesita autenticación para acceder a ellos. Pero si está buscando datos que son públicos, no necesita autenticación. Así que para recobrar una lista de mensajes que han sido publicados, puede utilizar:
Esto obtendría todos los mensajes publicados por el hecho de que son públicos.
Una vez que haya accedido a su lugar y sepa cómo emplear la autenticación (y, de hecho, si es necesario), tendrá que usar uno de una serie de comandos para interaccionar con su sitio.
Los comandos que necesitará emplear son:
GETrecupera un recurso como un post u otros datos.POSTañade un recurso al servidor, como un mensaje, un fichero adjunto o bien otro recurso.PUTse puede utilizar para editar o bien actualizar un recurso que ya está en el servidor.DELETEelimina un recurso del servidor. Utilícelo de forma cuidadosa!Echemos un vistazo a cada uno de ellos separadamente.
El comando GET
El commando
GETes probablemente el más utilizado: recupera datos. El siguiente ejemplo le mostrará una lista de todas las páginas publicadas en su sitio:
Tenga en cuenta que no he incluido la senda completa a su sitio en la línea de arriba, en tanto que ya ha accedido a ella usando WP-CLI.
Una vez recuperados esos datos, puede utilizarlos para informar al siguiente paso. Puede borrar uno de esos mensajes, editarlo o bien actualizarlo. Podría sencillamente mandar mensajes a su aplicación web.
Digamos que desea ir a buscar el último post. Usaría esto:
Hay una serie de argumentos que puede utilizar cuando trabaja con mensajes. Consulte elpara obtener más información.
El comando POST
Utilice
POSTpara añadir nuevos datos o bien recursos a su lugar.
Así que, por poner un ejemplo, si quiere crear un mensaje, empezará utilizando un comando
POST:
Esto crearía un nuevo boceto vacío.
A continuación, puede actualizar el mensaje usando un comando
PUTpara editarlo.
Con un comando
POST, también puede añadir otros recursos además de los puestos, incluyendo adjuntos y otros tipos de puestos.
Para añadir una página a su lugar, puede utilizar algo como esto:
Esto crearía una página vacía de exactamente la misma forma que crearía una entrada vacía.
El commando PUT
El comando
PUTle deja editar un recurso existente, incluyendo los mensajes.
Supongamos que tiene múltiples borradores en su sitio web. Quiere revisarlas y actualizar una para que se publique.
Podrías iniciar por conseguir una lista de todos los mensajes de borrador:
El sistema le dará una lista de todos los bocetos actuales. Puede modificar el status de uno de ellos usando su ID:
Esto accede a ese mensaje y le permite editarlo. servicio de diseño de tienda online ón, puede modificar su status usando el razonamiento de status:
O bien, puede agregar contenido al mensaje y publicarlo:
El servidor devolverá un estado de
200 - OKque indica que la petición PUT ha editado apropiadamente el mensaje.
El comando DELETE
El comando
DELETEhace lo que esperaría: borra un recurso. Por defecto, si lo emplea para borrar un mensaje, lo pondrá en la papelera en vez de borrarlo de forma permanente.
¿Cansado de experimentar inconvenientes con su sitio de WP? Consiga el mejor y más rápido soporte de alojamiento web con Kinsta!
Así que si quisiera desplazar el mensaje que termina de crear a la papelera, usarías esto:
Sin embargo, si quisiera pasar por alto la papelera y eliminarla de manera permanente, usaría el argumento
force:
Esto elimina permanentemente el mensaje sin opción de deshacerlo, con lo que se debe usar con precaución.
API REST de Wordpress no siempre y en toda circunstancia será el enfoque correcto para desarrollar un sitio web o una aplicación. He aquí ciertas consideraciones que debe tener en cuenta ya antes de emplearlo para el desarrollo:
Si su aplicación se marcha a emplear en dispositivos que no ejecutan JavaScript o por usuarios que seguramente la tengan desactivada, no se ejecutará si está usando API REST.
Un sitio WP codificado en PHP producirá HTML a fin de que no sufra este inconveniente. Los dispositivos que no emplean JavaScript son cada vez más extraños, pero si está desarrollando específicamente para ellos, API REST no funcionará.
Del mismo modo, si es probable que sus usuarios desactiven JavaScript, entonces trabajar con API REST causará problemas. Ciertos usuarios desactivan JavaScript en sus navegadores por razones de accesibilidad o seguridad.
Los sitios o aplicaciones desarrollados con JavaScript no siempre son tan accesibles como los que salen en código HTML.
Esto se debe en gran medida a la forma en que se emplea JavaScript para dar contenido dinámico que puede no marchar bien con los lectores de pantalla y puede causar problemas a las personas con deficiencias visuales o bien epilepsia fotosensible.
Usar API REST para acceder a su sitio WP y a los datos de salida de una forma que esté diseñada para ser alcanzable quiere decir que puede superar estos inconvenientes, mas merece la pena comprobar la accesibilidad de su sitio mientras que lo está desarrollando.
Las aplicaciones de una sola página, que se actualizan frecuentemente, a veces pueden causar. Esto es debido a que el contenido que no se entrega cuando se imprime por vez primera la página puede no ser indizado por los motores de búsqueda.
están poniendo al día con el hecho de que muchos sitios ahora tienen SPA y los están indexando apropiadamente. Pero vale la pena hacer unacompleta de cualquier lugar que desarrolle utilizando API REST.
Si no quiere que las aplicaciones puedan acceder a los datos de su lugar a través de API REST, puede desactivarla. Recuerde que los datos públicos pueden ser alcanzables para cualquier persona, no sólo para usted.
Para ello, puede instalar el complemento. Esto desactiva la API REST para cualquiera que no haya comenzado sesión en su lugar.
Deshabilitar WP REST API plugin
Alternativamente, puede añadir algún código al fichero de funciones de su tema o bien redactar su plugin. Es mejor redactar un complemento ya que no es una funcionalidad específica del tema.
En su plugin, añada sólo dos líneas:
Esto deshabilitará totalmente API REST para su lugar. Es posible que tenga efectos secundarios para sus pantallas de administración, así que asegúrese de que todo funciona correctamente cuando lo haya añadido.
La API REST presenta ciertas posibilidades interesantes para el futuro de Wordpress. Aquí hay algunos ejemplos de aplicaciones y sitios que emplean API REST de WordPress para crear SPAs o bien para enlazar WordPress con otros sitios y tecnologías.
WordPress.com
Las pantallas de administración de WordPress.com están construidas absolutamente utilizando API REST para proporcionar un SPA con el que los usuarios interactúan para administrar su sitio.
Esto hace que la comunicación entre la interfaz y el servidor sea dinámica y resulta en una interfaz fácil de usar que WP.org seguramente imitará con el tiempo.
El editor de Gutenberg
También en las pantallas de administración de Wordpress, pero esta vez también en Wordpress autohospedado, el editor de bloques de Gutenberg usa API REST para comunicarse con su base de datos y crear bloques.
Para que las clases de mensajes funcionen con el editor Gutenberg, deben tener habilitada API REST. Lo que quiere decir que si está registrando uny utiliza Gutenberg, tendrá que añadir la siguiente línea para habilitar el editor de bloques para ese tipo de mensaje:
Event Espresso
es un complemento de WordPress que permite a los usuarios organizar y promocionar eventos. Usa API REST para que los usuarios puedan acceder a los datos desde fuera de Wordpress. Esto significa que puede crear aplicaciones móviles o bien SPAs para gestionar sus acontecimientos.
UsTwo
es una agencia digital cuyo lugar fue construido utilizando API REST como una aplicación de una sola página. Esto combina un front-end construido usando React con un backend alimentado por WP (lectura sugerida:).
El contenido de su página única es modular, con una estructura diferente a la de una página estándar de WordPress. Para que esto funcione, usan un complemento de creación de páginas adaptado que permite a su equipo añadir contenido modular al sitio.
USA Today
El sitio web defue reconstruido usando la integración de API REST WP con los sistemas y módulos existentes en el sitio.
API REST permitió que el contenido del lugar fuera mandado a otros puntos de venta comoy Apple News, usando JSON. También escribieron un juego social en línea para su sección de deportes, construido utilizando JavaScript.
La API REST de Wordpress abre muchas oportunidades en el ecosistema de WordPress. Aprenda a sacarle el máximo provecho con esta guía en profundidad! 🔀⚙️ Haga click para Tweet
API REST de WordPress presenta algunos desafíos interesantes, mas también ocasiones interesantes tanto para los usuarios de Wordpress como para los desarrolladores. Es ely probablemente cambie radicalmente la manera en que desarrollamos con WP y la manera en que lo utilizamos.
¿Cuál es su opinión sobre API REST? ¿Lo ha utilizado para algunos de sus proyectos? Cuéntanoslo en la sección de comentarios de abajo!
Si le ha agradado este artículo, entonces le encantará la plataforma de Kinsta Wordpress alojamiento. Acelere su lugar y reciba soporte 24/7 de nuestro equipo de WordPress veterano. Nuestra infraestructura potenciada por Google Cloud se centra en escalamiento automático, desempeño y seguridad. ¡Déjenos mostrarle la diferencia con Kinsta!
| Êîììåíòèðîâàòü | « Ïðåä. çàïèñü — Ê äíåâíèêó — Ñëåä. çàïèñü » | Ñòðàíèöû: [1] [Íîâûå] |
