El complemento REST API (introducido con AIOSEO 4.1.9) está disponible para todos los usuarios de los planes Plus, Pro y Elite y le permite obtener y actualizar fácilmente datos de AIOSEO a través de la API REST.
Esto puede ser particularmente útil cuando, por ejemplo, tiene:
- Un sitio de WordPress headless donde necesita mostrar manualmente sus datos de SEO en el frontend;
- Un sistema de terceros para administrar sus publicaciones (por ejemplo, ERP de comercio electrónico con integración de WooCommerce) y le gustaría poder administrar sus datos de SEO a través de ese sistema.
A continuación, explicaremos qué datos están disponibles a través de la API REST y cómo puede actualizarlos.
NOTA:
El complemento REST API está disponible para clientes con un plan Plus o superior para All in One SEO Pro.
Obtención de datos
En lugar de registrar puntos de conexión personalizados, el complemento REST API se integra con los puntos de conexión predeterminados del núcleo de WordPress. Actualmente, se admiten todas las rutas GET de publicaciones y términos.
Estas incluyen:
- /wp/v2/posts
- /wp/v2/pages
- /wp/v2/media
- /wp/v2/categories
- /wp/v2/tags
Y también todas las rutas para tipos de publicaciones personalizadas y taxonomías personalizadas en su sitio web que tengan habilitada la compatibilidad con la API REST.
Los siguientes campos se incluirán en la respuesta de estas rutas:
aioseo_head
Este campo incluye los datos SEO sin procesar que normalmente All in One SEO generaría en el código fuente de su publicación/término como una cadena de texto.
Si tiene un sitio web de WordPress headless, puede mostrar estos datos directamente en el código fuente del frontend de su instalación.
aioseo_head_json
Este campo incluye los mismos valores que los datos de aioseo_head (ver arriba), pero en formato JSON.
Esto le permite filtrar fácilmente los datos antes de mostrarlos en el código fuente o utilizarlos para otro propósito.
Tenga en cuenta que estos datos no incluyen el código HTML de las etiquetas meta para las que se utilizan estos valores, por lo que deberá construirlos usted mismo.
aioseo_meta_data
Este campo incluye los datos que se almacenan en las tablas personalizadas de publicaciones y términos de AIOSEO en formato JSON.
Estos datos deben usarse principalmente cuando desee manipular los datos existentes y luego actualizarlos en su sitio web.
Actualización de datos
Para actualizar datos a través de la API REST, debe autenticarse. Si no está seguro de cómo hacerlo, lea la documentación de la API REST de WordPress.
El usuario con el que se ha autenticado también debe tener alguna de las siguientes capacidades para poder actualizar cualquier dato de AIOSEO a través de la API REST:
- aioseo_page_general_settings
- aioseo_page_social_settings
- aioseo_page_schema_settings
- aioseo_page_advanced_settings
Una vez que hayas cumplido estos requisitos, puedes actualizar los datos mediante una solicitud POST/PUT añadiendo la propiedad aioseo_meta_data en el cuerpo de la solicitud.
Dentro de esta propiedad, puedes especificar cualquiera de las claves incluidas en el campo aioseo_meta_data (ver arriba), junto con el nuevo valor.
A continuación, se muestra un ejemplo de cómo se ve:
{
"aioseo_meta_data": {
"title":"NEW TITLE",
"description":"NEW DESCRIPTION"
}
}
Si tienes alguna pregunta en particular sobre la API REST, no dudes en contactar con nuestro equipo de soporte. Estaremos encantados de ayudarte.