Guía Completa para Desarrolladores de la API de WordPress

Si estás desarrollando aplicaciones web, aplicaciones móviles o clientes front-end que necesitan interactuar programáticamente con un sitio de WordPress, la API de WordPress es tu herramienta clave. Con un sitio configurado correctamente y los puntos finales REST proporcionados por WordPress (o WordPress.com), puedes recuperar publicaciones, crear nuevo contenido, editar páginas existentes, administrar usuarios, comentarios y mucho más, todo a través de solicitudes HTTP estándar. Esta guía te explica cómo empezar con la API de WordPress, cómo funciona la estructura de URL, cómo realizar operaciones CRUD y cómo probar todo en un navegador o utilizando una herramienta de API como Apidog.

Primeros pasos con la API de WordPress

a) Configuración de la cuenta o del sitio

• Si estás utilizando un sitio de WordPress autoalojado (WordPress.org), asegúrate de que tu sitio esté instalado y funcionando.

• Si estás trabajando con un sitio de WordPress.com, inicia sesión en WordPress.com y localiza el Panel de control de tu sitio.

• Asegúrate de que el acceso a la API REST esté habilitado — por defecto, las instalaciones modernas de WordPress exponen la API REST de WP en your-site-url/wp-json/.

No se necesita creación de cuenta adicional más allá de tener acceso al sitio (y los permisos adecuados) — la API REST está integrada en el núcleo de WordPress y es accesible por defecto.

b) Comprender la estructura de la URL base

Para un sitio de WordPress autoalojado, la URL base de la API es:

https://your-site.com/wp-json/

Por ejemplo, para recuperar publicaciones, te dirigirías a:

https://your-site.com/wp-json/wp/v2/posts

Si los permalinks amigables están deshabilitados, WordPress aún puede servir la API a través de un parámetro de consulta de respaldo — pero en la mayoría de las configuraciones modernas, /wp-json/ funciona de forma predeterminada.

Para sitios alojados en WordPress.com (o sitios que usan la API REST de WordPress.com), la estructura de la URL puede diferir ligeramente, dependiendo del espacio de nombres y el identificador del sitio. Por ejemplo:

https://public-api.wordpress.com/{namespace}/{version}/sites/{site_id}/...

Consulta la documentación oficial en Recursos para desarrolladores de WordPress, para una guía más detallada sobre la estructura de la URL base.

Uso de la API REST de WordPress: Operaciones CRUD

La API de WordPress admite todas las operaciones CRUD estándar — Crear, Leer, Actualizar, Eliminar — utilizando el método HTTP apropiado (POST, GET, PUT, DELETE). Vamos a desglosarlas con ejemplos concretos que puedes probar en el navegador o usando Apidog.

1. Leer: Recuperar publicaciones o páginas

• Para obtener una lista de publicaciones:

GET https://your-site.com/wp-json/wp/v2/posts

• Para obtener una sola publicación por ID:

GET https://your-site.com/wp-json/wp/v2/posts/{id}

• Puedes añadir parámetros de consulta para filtrar o paginar los resultados — por ejemplo:

GET https://your-site.com/wp-json/wp/v2/posts?per_page=5&page=2

GET https://your-site.com/wp-json/wp/v2/posts?status=draft

También puedes controlar qué campos se devuelven usando el parámetro de consulta _fields (por ejemplo, ? _fields=id,title,excerpt,link) para reducir el tamaño de la carga útil y mejorar el rendimiento.

Lo mismo se aplica a páginas (a través de /wp-json/wp/v2/pages) u otros tipos de recursos como medios, comentarios, etc., dependiendo de lo que tu sitio exponga.

2. Crear: Añadir una nueva publicación

Si estás autenticado (como administrador o usuario con permisos), puedes crear una nueva publicación a través de:

POST https://your-site.com/wp-json/wp/v2/posts

Con un cuerpo JSON, por ejemplo:

{
  "title": "My New API Post",
  "content": "This post was created via the WordPress API.",
  "status": "publish"
}

Esta solicitud creará una nueva publicación. Opcionalmente, puedes establecer el estado en "draft" u otros estados válidos si no deseas publicar inmediatamente.

3. Actualizar: Editar una publicación existente

Para actualizar una publicación por ID (por ejemplo, actualizando su título o contenido):

PUT https://your-site.com/wp-json/wp/v2/posts/{id}

Ejemplo de cuerpo:

{
  "title": "Updated Title via API",
  "content": "Updated content from API."
}

Alternativamente, algunas implementaciones aceptan PATCH. Después de una solicitud exitosa, la API responde con el objeto de publicación actualizado.

4. Eliminar: Eliminar una publicación

Para eliminar una publicación por ID:

DELETE https://your-site.com/wp-json/wp/v2/posts/{id}

Por defecto, esto típicamente mueve la publicación a la Papelera (si la papelera está habilitada). Puedes añadir parámetros (dependiendo de la configuración del sitio) para eliminarla permanentemente, si es compatible.

Consideraciones de autenticación y seguridad al usar la API de WordPress

• Los datos públicos (por ejemplo, publicaciones publicadas) a menudo se pueden obtener sin autenticación.
• Para crear, actualizar o eliminar contenido, normalmente necesitas autenticación — a través de cookies de inicio de sesión de WordPress, Contraseñas de aplicación (disponibles desde WP 5.6) o sistemas basados en OAuth / tokens.
• Utiliza siempre HTTPS en producción para proteger las credenciales y los datos en tránsito.

Probar los puntos finales de la API de WordPress (Navegador o Apidog)

Puedes probar fácilmente los puntos finales utilizando un navegador o una herramienta de prueba de API como Apidog.

Usando el navegador:

• Pega la URL (por ejemplo, .../wp-json/wp/v2/posts) en la barra de direcciones del navegador.
• El navegador mostrará JSON sin formato — para hacerlo legible, instala una extensión de formateador de JSON (por ejemplo, JSON Formatter para Chrome, Firefox).

Usando Apidog:

• Crea un nuevo punto final de API en Apidog.
• Introduce la URL (por ejemplo, /wp-json/wp/v2/posts).
• Elige el método HTTP (GET, POST, PUT, DELETE).
• Añade cabeceras si es necesario (para autenticación).

• Envía la solicitud e inspecciona la respuesta JSON — Apidog muestra JSON estructurado, errores, cabeceras de respuesta y facilita la depuración más que las salidas de navegador en bruto.

Este método es especialmente útil para solicitudes POST/PUT/DELETE — donde solo el navegador carece de una forma sencilla de enviar cuerpos de solicitud JSON o cabeceras personalizadas.

Mejores prácticas y consejos para desarrolladores que usan la API de WordPress

1. Usa _fields o parámetros de paginación para limitar el tamaño de la carga útil al recuperar muchos datos.
2. Autentícate de forma segura utilizando Contraseñas de aplicación u OAuth para operaciones de escritura.
3. Verifica la configuración de los permalinks del sitio — asegúrate de que los permalinks amigables o las rutas REST de respaldo estén funcionando (wp-json/).
4. Gestiona los permisos — solo los usuarios con los roles adecuados pueden crear o eliminar contenido.
5. Limita la tasa y maneja errores — trata las fallas de la API de manera elegante y respeta los recursos del servidor.
6. Usa herramientas de formato JSON al probar en un navegador para mejorar la legibilidad o la depuración.

Preguntas Frecuentes (FAQ)

P1. ¿Siempre necesito una clave API para usar la API de WordPress?
No — para datos públicos como publicaciones o páginas públicas, puedes usar solicitudes GET sin autenticación. Sin embargo, para crear, editar o eliminar contenido, generalmente necesitas credenciales adecuadas. (Para más información sobre este tema, consulta WPZOOM)

P2. ¿Cuál es la diferencia entre los puntos finales wp-json/wp/v2/ y public-api.wordpress.com?
wp-json/wp/v2/ es utilizado por sitios de WordPress autoalojados (WordPress.org). La estructura public-api.wordpress.com/... es utilizada por sitios alojados en WordPress.com — la URL base y los espacios de nombres difieren, pero el concepto de la API REST sigue siendo similar. (Ver más ejemplos en Noroff FEU Content System)

P3. ¿Puedo crear puntos finales personalizados o exponer tipos de publicaciones personalizados en la API?
Sí. Por defecto, los tipos de publicaciones principales (publicaciones, páginas, medios, comentarios, etc.) están expuestos. Para tipos de publicaciones personalizados o campos personalizados (metadatos), es posible que necesites registrar el soporte REST en tu tema o plugin (por ejemplo, usando register_post_type(..., 'show_in_rest' => true)).

P4. ¿Cómo puedo probar los puntos finales de la API sin escribir código?
Puedes usar un navegador (para solicitudes GET) — simplemente navega a la URL del punto final. Para POST/PUT/DELETE (o operaciones que requieren autenticación), usa una herramienta cliente de API como Apidog. Te permite enviar cuerpos JSON, establecer encabezados e inspeccionar respuestas cómodamente.

P5. ¿Es seguro exponer datos de usuarios o comentarios a través de la API?
Si tu sitio permite el acceso público a ciertos recursos (como publicaciones o comentarios visibles públicamente), entonces sí — la API solo devuelve lo que está permitido. Para datos privados u operaciones autenticadas, asegúrate de que la autenticación y los permisos adecuados estén en su lugar.

Conclusión

La API de WordPress transforma tu sitio de WordPress en un backend programable, permitiéndote leer, crear, actualizar y eliminar contenido a través de llamadas HTTP estándar. Ya sea que estés construyendo un frontend de CMS "headless", una aplicación móvil o automatizando flujos de trabajo de contenido, la API REST te ofrece una interfaz robusta y flexible.

Al comprender la estructura de la URL, los puntos finales principales, la semántica CRUD, la autenticación y la metodología de prueba (a través del navegador o Apidog), puedes integrar WordPress con prácticamente cualquier sistema externo. Con buenas prácticas de API — autenticación segura, consultas eficientes y manejo adecuado — WordPress se convierte en algo más que una plataforma de blogs — se convierte en un backend de contenido con todas las funciones.