Récupération et mise à jour des données AIOSEO via l'API REST de WordPress

Le module complémentaire API REST (introduit avec AIOSEO 4.1.9) est disponible pour tous les utilisateurs des plans Plus, Pro et Elite et vous permet de récupérer et de mettre à jour facilement les données AIOSEO via l'API REST.

Cela peut être particulièrement utile lorsque vous avez par exemple :

  • Un site WordPress headless où vous devez afficher manuellement vos données SEO sur le frontend ;
  • Un système tiers pour gérer vos publications (par exemple, un ERP eCommerce avec intégration WooCommerce) et vous souhaitez pouvoir gérer vos données SEO via ce système.

Ci-dessous, nous expliquerons quelles données sont disponibles via l'API REST et comment vous pouvez les mettre à jour.

Récupération des données

Au lieu d'enregistrer des points de terminaison personnalisés, le module complémentaire API REST s'intègre aux points de terminaison par défaut du cœur de WordPress. Actuellement, toutes les routes GET pour les articles et les termes sont prises en charge.

Ceux-ci incluent :

  • /wp/v2/posts
  • /wp/v2/pages
  • /wp/v2/media
  • /wp/v2/categories
  • /wp/v2/tags

Et aussi toutes les routes pour les types de publication personnalisés et les taxonomies personnalisées sur votre site Web qui ont la prise en charge de l'API REST activée.

Les champs suivants seront inclus dans la réponse de ces routes :

aioseo_head

Ce champ inclut les données SEO brutes qui seraient normalement générées par All in One SEO dans le code source de votre article/terme sous forme de chaîne de caractères.

Si vous avez un site Web WordPress headless, vous pouvez afficher ces données directement dans le code source sur le frontend de votre installation.

aioseo_head_json

Ce champ inclut les mêmes valeurs que les données aioseo_head (voir ci-dessus), mais au format JSON.

Cela vous permet de filtrer facilement les données avant de les afficher dans le code source ou de les utiliser à d'autres fins.

Veuillez noter que ces données n'incluent pas le code HTML des balises meta pour lesquelles ces valeurs sont utilisées, vous devrez donc les construire vous-même.

aioseo_meta_data

Ce champ inclut les données stockées dans les tables personnalisées d'articles et de termes d'AIOSEO au format JSON.

Ces données doivent être principalement utilisées lorsque vous souhaitez manipuler les données existantes, puis les mettre à jour sur votre site Web.

Mise à jour des données

Afin de mettre à jour les données via l'API REST, vous devez vous authentifier. Si vous ne savez pas comment faire, veuillez lire la documentation de l'API REST de WordPress.

L'utilisateur avec lequel vous vous êtes authentifié doit également posséder l'une des capacités suivantes afin de pouvoir mettre à jour des données AIOSEO via l'API REST :

  • aioseo_page_general_settings
  • aioseo_page_social_settings
  • aioseo_page_schema_settings
  • aioseo_page_advanced_settings

Une fois que vous avez rempli ces conditions, vous pouvez mettre à jour les données via une requête POST/PUT en ajoutant la propriété aioseo_meta_data dans le corps de la requête.

À l'intérieur de cette propriété, vous pouvez spécifier l'une des clés incluses dans le champ aioseo_meta_data (voir ci-dessus), ainsi que la nouvelle valeur.

Voici un exemple de ce à quoi cela ressemble :

{
	"aioseo_meta_data": {
		"title":"NEW TITLE",
		"description":"NEW DESCRIPTION"
	}
}

Si vous avez des questions particulières sur l'API REST, n'hésitez pas à contacter notre équipe de support. Nous serons ravis de vous aider.