¿Qué es y para qué sirve?
A menos que sea un desarrollador web profesional, es posible que no sepa lo que significa "API de WordPress". La palabra que leíste en el blog, o lo que escuchaste en reuniones de trabajo, o simplemente algo con un amigo del sindicato.
Si este es tu caso, no te preocupes, porque esto es normal y hoy no todo el mundo sabe qué es y para qué sirve. Por esta razón, intentaré explicar en el lenguaje y la terminología más simples. ¿Qué es una API y cómo se usa la API de WordPress?Coge tu bolígrafo y papel, ¡vamos!
Que es API
Es técnicamente difícil hablar de API, pero no es difícil entender el propósito general de una API.
API (API o API) Esta es una característica de ciertos servicios que permiten a los desarrolladores interactuar con ellos desde aplicaciones externas.En definitiva, es un conjunto de funciones y procedimientos que le permiten acceder a las funciones del software desde el exterior. De esa manera, el código de la aplicación original se abstrae y no necesita saber cómo funciona el código, y no necesita saberlo para usarlo.
Por ejemplo, la versión para iPhone o Android de la aplicación de Twitter llama a la API de la red social para obtener los datos que la aplicación quiere mostrar. Datos como tu perfil, historial, tweets específicos con toda la información.
Además, el exterior de la API prácticamente no ha cambiado. Esto significa que cualquier programación realizada con él requiere muy poco mantenimiento y no requiere ningún cambio durante un largo período de tiempo.
En definitiva, desde una aplicación o programa específico se puede acceder rápida y fácilmente a las funciones de otra aplicación o programa. Muy interesante, ¿no?
Bueno, estas API (después de ejecutar las solicitudes y funciones adecuadas) devuelven resultados en varios formatos. Por ejemplo, API de WordPress (Ver más abajo) Devuelve los datos de la solicitud en formato JSON. De esta forma, todos los programas que quieran conectarse a la API de WordPress utilizan el mismo formato de intercambio y pueden utilizar las funciones de la API, incluso si proceden de distintas fuentes. Entendimiento mutuo: es como todos nosotros, no importa de qué país vengamos y qué idioma hablemos, hablamos inglés.
Una vez que se ha desarrollado la API (y cualquier trabajo necesario para hacerlo), depende del desarrollador o de la empresa desarrolladora decidir qué poner a disposición del resto de la red. Por ejemplo, si marca API de Twitter O la API de WordPress, verá que su uso está bien explicado y documentado porque están interesados en obtener más usuarios de su red social o CMS.
Por supuesto, a medida que los sitios web se vuelven más complejos, las API se vuelven cada vez más necesarias, ya que le permiten incorporar nuevas características y funcionalidades en su sitio web. Insertar mapa de Google Maps Utilice todas las funciones de su sitio web sin tener que codificar e ingresar manualmente todos los datos La tienda online se desarrolla en WooCommerce Utilice sus procesos de inventario y facturación para evitar errores y acortar los tiempos de producción.
Que es un servicio REST
Ahora que sabes qué es una API y cuál es su propósito, explicaré brevemente otro término que debes conocer: REST.
REST (Transferencia de estado representativo) Este es el estilo arquitectónico que se usa actualmente para describir las interfaces que se pueden usar entre sistemas que usan HTTP para transferir información.
Los servicios web REST se han vuelto muy populares a lo largo de los años. Si te has dado cuenta, muchas de las empresas con las que hablas a menudo tienen empresas como Twitter, Facebook, Amazon, Google Maps, Youtube ... por supuesto que también existe WordPress.
Esto se debe a que estos servicios tienen muchos Una ventaja importante:
- Son escalables, fiables y flexibles.
- Prácticamente no consumen recursos del servidor.
- La tecnología, el cliente y el servidor intercambian datos a través de JSON, lo que los hace independientes entre sí.
La API REST define ciertas funciones para que los desarrolladores puedan realizarles solicitudes utilizando el protocolo HTTP. Todo esto permite su uso en cualquier sistema. Hay algunos consejos a tener en cuenta:
- Utilice los URI correctamente: La dirección debe ser única ya que cada dirección apunta a un recurso específico y único. También debe ser "independiente del formato". En otras palabras, si desea otorgar acceso a un recurso, no agregue su extensión. Por ejemplo, "/raiola/1223.txt" es incorrecto y "/ raiola / 1223" es correcto. URI también significa que no hay operación, es decir, no se puede agregar a la ruta: editar, eliminar ... aquí solo es importante identificar unívocamente el recurso. Estas operaciones se realizan utilizando los métodos HTTP que verá más adelante. Finalmente, es importante que la URI mantenga una jerarquía lógica.
- Utilice el método HTTP correctamente: No entraré en detalles ya que necesito usar este artículo específicamente para discutir REST, pero explicaré cuáles son los métodos disponibles:
- GET: solicita y lee recursos. Ejemplo: GET / raiola / 123.
- POST: Crea un nuevo recurso. Ejemplo: POST / raiola / 123.
- PUT: Edita los recursos existentes.
- BORRAR: Elimina recursos.
- PARCHE: edita una parte específica de un recurso.
- Artista hipermedia: El cliente no necesita conocer el URI de la API.
Que es JSON
Finalmente, antes de sumergirnos en la API de WordPress, debe saber qué es JSON y cómo se usa en la API. JSON (JavaScript Object Notation) es un formato de texto ligero que se utiliza principalmente para almacenar e intercambiar información.
Como ya se mencionó, estos datos son generados por la propia API cuando el sistema realiza una solicitud. Al ser texto plano, es independiente del lenguaje de programación y puede ser interpretado por el sistema sin problemas. Cada idioma tiene una biblioteca que puede codificar y decodificar datos en JSON.
Su sintaxis es muy sencilla:
- Cada elemento de datos consta de un par de nombre y valor. En otras palabras, si quiero enviarles el nombre de mi empresa, tiene que estar en JSON "empresa": "Raiola Networks".
- Cada mensaje está separado por una coma.
- Ese [] Contiene articulos.
- {} Cree una matriz para almacenar pares de datos.
Veamos un ejemplo que sigue esta sintaxis:
{"Empresa": "Raiola Networks" "localidad": "Lugo" "productos": {"producto1": "Alojamiento SSD Base", "producto2": "VPS SSD optimizado"}}
{ "sociedad":"Layola Internet" "Un lugar":"Lugo" "producto": { "Objeto 1":"Hosting SSD de acuerdo a","Artículo 2":"Red privada virtual SSD mejoramiento"} } |
Tenga en cuenta que un par puede incluir un conjunto de pares en su valor. Como puede ver, es informativo y muy fácil de leer y explicar para los usuarios.
API REST de WordPress para desarrolladores
Este artículo le dará una comprensión clara de qué es una API y cuáles son sus principales funciones y capacidades. Así que es hora de migrar todo lo que ha aprendido con la API de WordPress.
La API REST de WordPress forma parte de este CMS desde 2015. Se utiliza para administrar datos de texto de un sitio a otro sin acceso directo del usuario final a la base de datos o la interfaz. En otras palabras, este CMS le brinda una interfaz para que otros sistemas interactúen con su sitio. Por ejemplo, si tu Si desarrolla una aplicación para teléfonos móviles y tabletas, puede utilizar la aplicación para acceder a los datos de su sitio web.
Esto significa que el uso de este administrador de contenido se puede ampliar para cualquier tipo de desarrollo, ya que la API de WordPress permite una integración completa con plataformas de terceros.
Conceptos básicos de la API REST de WordPress
Como le expliqué al principio qué son una API y otros términos relacionados, comprenderá mejor los elementos importantes de la API REST de WordPress en pocas palabras:
- Recurso: Este es un elemento de información disponible a través de la API. En la API de WordPress, los recursos pueden ser páginas, publicaciones, usuarios ...
- el fin: El punto final es la ruta al recurso. Si va a "su nombre de dominio / wp-json /", verá todos los puntos finales que ya están disponibles en su sitio. Puede ver las URL de los puntos finales más utilizados en la documentación oficial de la API de WordPress.
- Consulta o consulta: El propósito de una solicitud HTTP a un recurso es que el sistema devuelva una respuesta con información. Cuando un sistema o complemento externo en su sitio web realiza una solicitud a un recurso de API, se crea un objeto WP_REST_Request en WordPress.
- Responder o contestar: Esta es la información que devuelve la API. En este caso, se crea una WP_REST_Response en WordPress. Instancia de la clase.
- Arquitectura o arquitectura: Es un esquema de metadatos que se utiliza para describir una estructura de datos. La API de WordPress usa el modo JSON. En el ejemplo de la sección Qué es JSON, puede ver cómo se estructuran los datos del punto final. Aunque no se requiere el uso de esquemas, se recomienda.
- Clase de controlador: le permite personalizar la API y crear sus propios puntos finales.
Cómo habilitar la API de WordPress
WordPress ha estado integrando su API REST localmente durante algún tiempo, especialmente después de la versión 4.7, pero si no puede acceder a ella, ya sea por su versión de WordPress o por su Maestro (Para estar seguro) Él siempre te lo ocultó Puede activarlo manualmente instalando un complemento llamado WP REST API Controller.Puede encontrarlo en el repositorio de complementos de WordPress.
Después de instalar y activar el complemento, puede utilizar la API de WordPress para su proyecto.
Para acceder a la API, siempre debe comenzar en la siguiente ruta: http://yourdomain.com/wp-json/wp/v2. ¿Por qué? Lo desglosaré para que puedas ver:
- http://tudominio.com: Su URL, aunque también puede trabajar localmente en http: // localhost.
- / wp-json: Prefijo de URL de la API REST de WP.
- / wp: El nombre de la URL.
- / v2: Versión de la API WP REST.
Después de esta URL, puede agregar recursos de navegación, por ejemplo: / posts, para ver una lista de las publicaciones publicadas en su sitio web.
Si ingresa esta ruta en su navegador o en el complemento del lector JSON, obtendrá esta información (si está utilizando Mozilla Firefox). Si no es así, pruebe con otros navegadores o programas y obtendrá la misma información, pero con un estilo diferente.
La imagen que ves arriba es un esquema. Como expliqué anteriormente, esto no es más que una vista de los datos que componen la respuesta de la API a mi solicitud anterior. En este caso particular, la información está en el blog.
Como ves, los campos id, título, contenido, autor ... forman parte de la respuesta que proporciona la API y son muy útiles para futuras integraciones con otros sistemas.
Para probar estas solicitudes y obtener una plantilla para una respuesta, puede hacerlo en su propio navegador, pero a veces esto no es suficiente o no es muy claro visualmente (especialmente si está usando Chrome). este programa carteroEsto le permite crear consultas según sea necesario y visualizar sus resultados.
permisible Crea una publicación de blog sobre PHPCon este código simple, puede iniciar sesión en su WordPress desde un sitio externo y crear una nueva publicación en él. Y todo esto sin tener que iniciar sesión.
'Titulo Post Nuevo', 'content' => 'Contenido nueva entrada', 'status' => 'publicar'); $ cadena_datos = json_encode ($ datos); $ headers = array ('Content-Type: application / json', 'Content-Length:' .strlen ($ data_string), 'Authorization: Basic'.base64_encode (' admin: clave ')); $ ch = curl_init ($ host); curl_setopt ($ ch, CURLOPT_HTTPHEADER, $ encabezado); curl_setopt ($ ch, CURLOPT_CUSTOMREQUEST, 'POST'); curl_setopt ($ ch, CURLOPT_POSTFIELDS, $ cadena_datos); curl_setopt ($ ch, CURLOPT_RETURNTRANSFER, 1); $ resultado = curl_exec ($ ch $ resultado);
1 2 3 Cuarto 5 Sexto Séptimo ocho nueve diez once 12 13 catorce quince dieciséis 17 | <?php PSMaestro = 'http://tudominio.com/wp-json/wp/v2/posts/'; PSdatos = Gran cantidad('Título' => 'Nombre de mensaje nuevo', 'Contenido' => 'Contenido de la nueva publicación', 'Estado' => 'Publicación'); PSLinea de datos = json_encode(PSdatos); PStítulo = Gran cantidad( 'Tipo de contenido: Aplicación / JSON', 'Largancia de contenido:' ... Actual(PSLinea de datos), 'Autorización: Simple'... base64_encode('Contraseña de administrador') ); PSCH = curl_init(PSMaestro); curl_setopt(PSCH, CURLOPT_HTTPHEADER, PStítulo); curl_setopt(PSCH, CURLOPT_CUSTOMREQUEST, "correo"); curl_setopt(PSCH, CURLOPT_POSTFIELDS, PSLinea de datos); curl_setopt(PSCH, CURLOPT_RETURNTRANSFER,1); PSResultado = curl_exec(PSCH); curl_close(PSCH); eco(PSResultado); |
Del mismo modo que creó el código PHP para crear publicaciones de blog, puede crear otro código para editar o eliminar publicaciones y páginas en su sitio web.
cheque
Obviamente, no todo el mundo puede acceder a la información de los terminales. Tiene información disponible públicamente en su sitio web, así como datos personales. Por lo tanto, en muchos casos, deberá autenticarse antes de poder utilizar los recursos de WordPress solicitados a través de la API, p. Ej. B. crear usuarios o publicar artículos y páginas.
Hay tres formas de autenticarse con la API de WordPress:
- Uso de cookies: Este es el método de autenticación estándar disponible en este sistema. Está conectado a un usuario humano desarrollado para WordPress. Después de iniciar sesión en el panel, se crea una cookie. Al usar esta cookie, puede Los desarrolladores acceden a la API de WordPress.
- Complemento o complemento: Hay algunos complementos que puede utilizar para utilizar alternativas para autenticar sistemas externos en su sitio: Servidor de WordPress REST API-OAuth 1.0a Esto es un ejemplo.
Con esta autenticación, su API de WordPress es segura y no es accesible para nadie que pueda acceder a ella, y mucho menos editar sus recursos de red.
¿Cómo desactivo la API REST de WordPress?
Si eres de esas personas que no confían en la nueva API de WordPress o no quieres usarla en absoluto, es mejor mantener esta función desactivada. Recuerde, si su versión de WordPress es inferior a 4.7, la API la desactivará llamando a Original. De lo contrario, debe seguir los pasos a continuación para completar la desactivación sin usar un complemento.
Edite su archivo functions.php y agregue las siguientes líneas:
add_filter ('json_enabled', '__ return_false'); add_filter ('json_jsonp_enabled', '__ return_false');
Añadir filtro('json_enabled', '__ regresa incorrectamente'); Añadir filtro('json_jsonp_enabled', '__ regresa incorrectamente'); |
Es muy fácil deshabilitar la API de WordPress sin usar un complemento.
finalmente
El desarrollo y la implementación de la API de WordPress pueden representar avances importantes para los desarrolladores. Debido a la versatilidad de WordPress, muchas personas han tenido que elegir este CMS para implementar en la mayoría de sus proyectos.
La API de WordPress simplificará la conexión entre aplicaciones y servicios de terceros. Mejora la experiencia del usuario, reduce los costos de desarrollo y aumenta la funcionalidad del CMS, lo que también beneficia a los usuarios finales o diseñadores de sitios web habituales.
Además, como API económica, WordPress tiene su propia API completa Instrucciones para la integración de la API REST de WordPress Y toda la comunidad activa de este CMS que existe en la red. Por lo tanto, el fácil acceso a recursos, tutoriales e información es otro beneficio del uso de la API de WordPress.
Si se encuentra entre los que han probado la API de WordPress, no dude en dejar un mensaje en los comentarios para contarnos su experiencia. La comunidad de WordPress te agradece
Deja una respuesta