Aller au contenu Accéder à la navigation
Retour au support

Débuter avec l’API REST SEOPress

Méthodes d’authentification

Via les cookies de WordPress

Headers à envoyer avec votre requête :

  • X-WP-Nonce : ouvrez votre console de navigateur, saisissez « wpApiSettings » et copiez le nonce
  • Cookie : ouvrez votre console de navigateur, allez dans Applications, et copiez le nom ET la valeur de ce cookie wordpress_logged_in_ (ex : wordpress_logged_in_41432erzre768dffez23456=admin%AREGREJOGRE54Y65KO534KTO4O3TJ43EFFEKZFOEZK£FEZRGTH)

Via des mots de passe d’application

SEOPress 6.8 est requis.

C’est la meilleure solution. Créez un mot de passe d’application à partir de votre profil WordPress.

Utilisez votre identifiant WP (ex : admin) et ce nouveau mot de passe d’application pour vous authentifier (choisissez « Basic Authentification » dans Postman ou équivalent).

Body (JSON Object) à envoyer avec votre requête en fonction du endpoint :

Titre et méta description

{
    "title":"this is SEO title",
    "description":"this is meta description"
}

Mots clés cibles

{
    "_seopress_analysis_target_kw":"keyword1, keyword2"
}

Métadonnées Sociales

{
    "_seopress_social_fb_title":"my facebook title",
    "_seopress_social_fb_desc":"my facebook description",
    "_seopress_social_fb_img":"facebook image URL",
    "_seopress_social_fb_img_attachment_id":"facebook attachment ID",
    "_seopress_social_fb_img_width":"facebook attachment width",
    "_seopress_social_fb_img_height":"facebook attachment height",
    "_seopress_social_twitter_title":"my twitter title",
    "_seopress_social_twitter_desc":"my twitter description",
    "_seopress_social_twitter_img":"twitter image URL",
    "_seopress_social_twitter_img_attachment_id":"twitter attachment ID",
    "_seopress_social_twitter_img_width":"twitter attachment width",
    "_seopress_social_twitter_img_height":"twitter attachment height"
}

Méta robots

{
    "_seopress_robots_index":"yes",
    "_seopress_robots_follow":"yes",
    "_seopress_robots_archive":"yes",
    "_seopress_robots_snippet":"yes",
    "_seopress_robots_imageindex":"yes",
    "_seopress_robots_canonical":"my canonical URL",
    "_seopress_robots_primary_cat":"my primary cat ID",
    "_seopress_robots_breadcrumbs":"my custom breadcrumbs"
}

Depuis SEOPress 10.4, le terme principal d’une autre taxonomie hiérarchique publique a sa propre clé, _seopress_robots_primary_term_{taxonomy} (par exemple _seopress_robots_primary_term_genre). Elle prend un ID de terme, ou une valeur vide pour le retirer. _seopress_robots_primary_cat reste la clé des catégories et des catégories de produits.

Redirection

{
    "_seopress_redirections_enabled":"yes",
    "_seopress_redirections_logged_status":"both|only_logged_in|only_not_logged_in",
    "_seopress_redirections_type":"301|302|307",
    "_seopress_redirections_value":"my redirection URL"
}

Depuis SEOPress 10.4, seul un utilisateur disposant de la capacité manage_options ou unfiltered_html peut rediriger vers un autre site. Voir Sécurité et sites headless plus bas.

Réponse :

Si succès :

{
    "code": "success"
}

Si échec :

{
    "code": "rest_forbidden",
    "message": "Sorry, you are not allowed to do that.",
    "data": {
        "status": 401
    }
}

ou

{
    "code": "rest_cookie_invalid_nonce",
    "message": "Cookie check failed",
    "data": {
        "status": 403
    }
}

ou, depuis SEOPress 10.4, lorsque la cible de la redirection est refusée :

{
    "code": "seopress_redirection_external_target",
    "message": "You are not allowed to redirect this content to another website. Use a URL on this site, or ask an administrator.",
    "data": {
        "status": 403
    }
}

Obtenir les métadonnées des posts

Depuis SEOPress 5.0, vous pouvez obtenir vos métadonnées SEO en utilisant notre API REST.

Ces routes GET sont publiques et ne nécessitent ni authentification ni capacité edit_post. Les métadonnées sont renvoyées uniquement pour les contenus publiés d’un type de contenu consultable par les visiteurs (depuis SEOPress 10.4), lorsque la protection par mot de passe ne bloque pas la requête.

2 routes sont actuellement disponibles :

  • /wp-json/seopress/v1/posts/[postId] : remplacez [postId] par l’ID du post
  • /wp-json/seopress/v1/posts/by-url?url=https://example.com/seopress-best-wordpress-seo-plugin/ replacez l’URL par le permalien souhaité

Méthode disponible : GET.

Lorsque les métadonnées sont disponibles, la réponse contient success: true et les métadonnées dans data. Sinon, data vaut null. Le JSON ci-dessous représente uniquement l’objet data ; le titre se lit par exemple dans response.data.title.

{ 
    "title": "SEOPress, Best WordPress SEO plugin", 
    "description": "My super meta description", 
    "canonical": "https://example.com/seopress-best-wordpress-seo-plugin/", 
    "og": { 
        "title": "My Facebook title", 
        "description": "My Facebook description", 
        "image": "https://example.com/seopress-best-wordpress-seo-plugin.jpg",
        "attachment_id": "1",
        "image_width": "1920",
        "image_height": "1080"
    }, 
    "twitter": { 
        "title": "My Twitter title", 
        "description": "My Twitter description", 
        "image": "https://example.com/seopress-best-wordpress-seo-plugin.jpg",
        "attachment_id": "1",
        "image_width": "1920",
        "image_height": "1080"
    },
    "robots": {
        "noindex": false, 
        "nofollow": false, 
        "nosnippet": false, 
        "noimageindex": false 
    },
    "primarycat": "1",
    "breadcrumbs": "my custom breadcrumbs for current item",
    "redirections": {
        "enabled": true,
        "status":"both",
        "type":"301",
        "value":"https://example.com/destination-url/"
    }
}

Pour obtenir vos données, vous pouvez par exemple utiliser l’API HTTP WordPress

Obtenir les métadonnées des termes

Depuis SEOPress 5.5, vous pouvez obtenir les métadonnées SEO de vos termes de taxonomies en utilisant notre API REST.

Cette route GET est publique, avec ou sans le paramètre taxonomy, et ne nécessite ni authentification ni capacité edit_post. Depuis SEOPress 10.4, elle ne décrit que les termes d’une taxonomie publiquement interrogeable, et le terme doit appartenir à la taxonomie demandée : pour une catégorie de produits WooCommerce, par exemple, ajoutez ?taxonomy=product_cat.

2 routes sont actuellement disponibles :

  • /wp-json/seopress/v1/terms/[termId] : remplacez [termId] par l’ID de votre terme
  • /wp-json/seopress/v1/terms/[termId]?taxonomy=[yourCustomTaxonomy] similaire à la route précédente, avec la taxonomie comme argument (par défaut : « category » si non fourni)

Méthode disponible : GET.

Lorsque les métadonnées sont disponibles, la réponse contient success: true et les métadonnées dans data. Sinon, data vaut null. Le JSON ci-dessous représente uniquement l’objet data ; le titre se lit par exemple dans response.data.title.

{ 
    "title": "My super term title", 
    "description": "My super term meta description",
    "canonical": "https://example.com/seopress-best-wordpress-seo-plugin/",
    "og": { 
        "title": "My Facebook term title", 
        "description": "My Facebook term description", 
        "image": "https://example.com/term-seopress-best-wordpress-seo-plugin.jpg",
        "attachment_id": "1",
        "image_width": "1920",
        "image_height": "1080" 
    }, 
    "twitter": { 
        "title": "My Twitter term title", 
        "description": "My Twitter term description", 
        "image": "https://example.com/term-seopress-best-wordpress-seo-plugin.jpg",
        "attachment_id": "1",
        "image_width": "1920",
        "image_height": "1080"
    }, 
    "robots": { 
        "noindex": false, 
        "nofollow": false, 
        "nosnippet": false, 
        "noimageindex": false 
    },
    "breadcrumbs": "my custom breadcrumbs for current item",
    "redirections": {
        "enabled": true,
        "status":"both",
        "type":"301",
        "value":"https://example.com/destination-url/"
    }
}

Envoyer des métadonnées de posts

Pour écrire des métadonnées SEO, vous pouvez utiliser ces points de terminaisons :

  • titre et méta description : /wp-json/seopress/v1/posts/[postId]/title-description-metas
  • mots clés cibles : /wp-json/seopress/v1/posts/[postId]/target-keywords
  • métas sociales : /wp-json/seopress/v1/posts/[postId]/social-settings
  • métas robots : /wp-json/seopress/v1/posts/[postId]/meta-robot-settings
  • redirection : /wp-json/seopress/v1/posts/[postId]/redirection-settings

Capacité utilisateur requise par sécurité : edit_post

Méthode disponible : PUT.

Un rôle coché dans SEO > Réglages avancés > Sécurité ne peut pas utiliser ces routes, comme dans la metabox SEO : Metaboxes SEO : rôles bloqués pour toutes, Analyse du contenu : rôles bloqués pour les mots clés cibles. Depuis SEOPress 10.4, la même restriction s’applique à la lecture de ces routes en GET, et la cible de la redirection est vérifiée (voir plus bas).

Sécurité et sites headless (depuis SEOPress 10.4)

SEOPress 10.4 restreint ce que l’API REST montre aux visiteurs et ce que chaque rôle peut modifier. Si vous utilisez un front-end headless, ou une intégration qui lit ou écrit des données SEO, vérifiez les points ci-dessous.

Les routes publiques ne décrivent que les contenus publics

Les routes publiques seopress/v1/posts/[postId], seopress/v1/posts/by-url et seopress/v1/terms/[termId] sont ouvertes à tous. Elles ne décrivent désormais que ce qu’un visiteur pouvait déjà consulter :

  • les contenus d’un type de contenu consultable (articles, pages, produits, types de contenu personnalisés publics). Les blocs réutilisables, les parties de modèle et les enregistrements internes d’autres extensions renvoient data: null, même publiés ;
  • les termes d’une taxonomie publiquement interrogeable, et seulement si le terme existe dans la taxonomie demandée.

Pour exposer volontairement un type de contenu ou une taxonomie interne, par exemple pour une intégration qui reposait sur l’ancien comportement, utilisez ces filtres. Les brouillons et les contenus protégés par mot de passe restent masqués, quoi que renvoie le filtre des contenus.

// Describe the posts of an internal post type in the public SEO route.
add_filter( 'seopress_api_public_post_is_readable', function( $allowed, $post_id, $post_type ) {
	if ( 'my_internal_type' === $post_type ) {
		return true;
	}
	return $allowed;
}, 10, 3 );

// Describe the terms of a non-public taxonomy in the public SEO route.
add_filter( 'seopress_api_public_term_is_readable', function( $allowed, $term_id, $taxonomy ) {
	if ( 'my_internal_taxonomy' === $taxonomy && term_exists( $term_id, $taxonomy ) ) {
		return true;
	}
	return $allowed;
}, 10, 3 );

Les métas SEO dans les routes du cœur de WordPress (/wp/v2)

SEOPress enregistre ses métas de contenu sur les routes REST du cœur de WordPress (/wp/v2/posts, /wp/v2/pages, etc.) pour que l’éditeur de blocs puisse les lire et les enregistrer. Jusqu’à la 10.4, elles figuraient aussi dans les réponses publiques de ces routes. Depuis SEOPress 10.4 :

  • un utilisateur qui ne peut pas modifier le contenu, visiteurs compris, ne reçoit plus aucune méta SEOPress (_seopress_*) dans le champ meta. Par défaut, aucune clé ne reste publique ;
  • un utilisateur qui peut modifier le contenu les conserve, sauf les clés d’une zone dont son rôle est bloqué dans SEO > Réglages avancés > Sécurité (par exemple les mots clés cibles pour un rôle coché dans Analyse du contenu : rôles bloqués).

Pour un front-end headless, la source recommandée est la route seopress/v1/posts/[postId] : elle renvoie les valeurs telles qu’elles sont rendues. Si votre front-end lit les métas brutes depuis /wp/v2, listez les clés qui doivent rester publiques avec le filtre seopress_rest_public_meta_keys :

// Keep the SEO title and meta description in public /wp/v2 responses.
add_filter( 'seopress_rest_public_meta_keys', function( $keys, $post ) {
	$keys[] = '_seopress_titles_title';
	$keys[] = '_seopress_titles_desc';
	return $keys;
}, 10, 2 );

Ne listez que les clés dont votre front-end a besoin : les mots clés cibles, une redirection non activée ou les réglages de l’analyse de contenu n’ont pas vocation à être publics.

Redirections vers un autre site

Tout utilisateur qui peut modifier un contenu peut activer sa redirection. Depuis SEOPress 10.4, la cible de la redirection d’un contenu ou d’un terme doit se trouver sur votre site, sauf si l’utilisateur dispose de la capacité manage_options ou unfiltered_html. Cela empêche un utilisateur de transformer l’une de vos URL en lien vers n’importe quel domaine (une redirection ouverte).

  • Une cible sur votre site, ou sur un hôte ajouté avec le filtre WordPress allowed_redirect_hosts, est toujours acceptée.
  • Conserver la cible déjà enregistrée est accepté : un auteur peut donc toujours mettre à jour un contenu qu’un administrateur a redirigé.
  • Rien n’est vérifié lorsqu’aucun utilisateur n’est connecté (cron, WP-CLI, imports).
  • Le gestionnaire de redirections de SEOPress PRO n’est pas concerné : il a ses propres capacités.

La règle s’applique à toutes les façons d’enregistrer la redirection d’un contenu ou d’un terme, API REST comprise. Avec PUT /wp-json/seopress/v1/posts/[postId]/redirection-settings, une cible refusée renvoie l’erreur seopress_redirection_external_target (HTTP 403) et rien n’est enregistré. Via /wp/v2, la cible précédente est conservée sans message. Pour autoriser d’autres utilisateurs à rediriger vers un autre site, utilisez le filtre seopress_redirection_external_target_allowed :

// Accept the shop subdomain as a redirection target for every user who can edit the post.
add_filter( 'seopress_redirection_external_target_allowed', function( $allowed, $url ) {
	if ( 'shop.example.com' === wp_parse_url( $url, PHP_URL_HOST ) ) {
		return true;
	}
	return $allowed;
}, 10, 2 );

Restrictions de la metabox SEO sur les routes de lecture

Les routes d’écriture de la metabox SEO refusaient déjà un rôle coché dans SEO > Réglages avancés > Sécurité. Depuis SEOPress 10.4, les routes GET que lit la metabox suivent la même règle : un rôle bloqué ne peut plus récupérer les champs que la metabox lui masque. Les administrateurs ne sont jamais bloqués.

Route Refusée lorsque le rôle est coché dans
title-description-metas, target-keywords, meta-robot-settings, preview-title-description-metas, page-preview, count-target-keywords-use Metaboxes SEO : rôles bloqués et Analyse du contenu : rôles bloqués à la fois
social-settings, redirection-settings, redirection-test Metaboxes SEO : rôles bloqués
content-analysis (GET) et content-analysis/analyze (POST) Analyse du contenu : rôles bloqués

Toutes ces routes se trouvent sous /wp-json/seopress/v1/posts/[postId]/ et exigent toujours la capacité edit_post. Depuis la 10.4, les abilities SEOPress qui modifient des réglages SEO appliquent les mêmes restrictions de rôle (la lecture y reste autorisée), voir Utiliser les abilities SEOPress (Free et PRO).

Obtenir les réglages SEOPress

Depuis SEOPress 5.5, vous pouvez demander les paramètres globaux de SEOPress via notre API REST.

Notez que pour des raisons de sécurité, vous devez être connecté avec un utilisateur disposant de la capacité manage_options.

10 routes sont actuellement disponibles :

  • /wp-json/seopress/v1/options/dashboard-settings : Réglages du tableau de bord
  • /wp-json/seopress/v1/options/titles-settings : Réglages des titres et métas
  • /wp-json/seopress/v1/options/social-settings : Réglages des réseaux sociaux
  • /wp-json/seopress/v1/options/sitemaps-settings : Réglages des plans de site
  • /wp-json/seopress/v1/options/analytics-settings : Réglages de statistiques et mesures d’audience
  • /wp-json/seopress/v1/options/advanced-settings : Réglages avancés
  • /wp-json/seopress/v1/options/bot-settings : Réglages du Bot
  • /wp-json/seopress/v1/options/indexing-settings : Réglages de l’indexation instantanée
  • /wp-json/seopress/v1/options/license-settings : Réglages de la licence
  • /wp-json/seopress/v1/options/pro-settings : Réglages PRO

Méthode disponible : GET.

Vous obtiendrez en réponse un JSON contenant les informations suivantes (ex. avec les réglages du tableau de bord) :

{
  "cards_order": [
    "seopress-page-list",
    "notice-insights-alert",
    "seopress-news-panel"
  ],
  "toggle-rich-snippets": "1",
  "toggle-404": "1",
  "toggle-bot": "1",
  "toggle-titles": "1",
  "toggle-white-label": "0",
  "toggle-social": "1",
  "toggle-xml-sitemap": "1",
  "toggle-google-analytics": "1",
  "toggle-advanced": "1",
  "toggle-woocommerce": "1",
  "toggle-edd": "1",
  "toggle-local-business": "1",
  "toggle-dublin-core": "1",
  "toggle-breadcrumbs": "1",
  "toggle-robots": "1",
  "toggle-news": "1",
  "toggle-rewrite": "1",
  "toggle-instant-indexing": "1",
  "notice-wizard": "1"
}

Obtenir l’historique de l’indexation instantanée

Depuis SEOPress 10.4, chaque URL soumise à IndexNow ou à Google, manuellement ou automatiquement, est enregistrée dans un historique que vous pouvez obtenir via notre API REST.

Notez que pour des raisons de sécurité, vous devez être connecté avec un utilisateur disposant de la capacité manage_options, sauf pour la route par contenu (edit_post).

2 routes sont actuellement disponibles :

  • /wp-json/seopress/v1/instant-indexing/history : tout l’historique, du plus récent au plus ancien, liste des arguments ci-dessous :
    • page (facultatif) : integer, 1 par défaut
    • per_page (facultatif) : integer, de 1 à 100, 20 par défaut
    • search (facultatif) : string, une partie d’URL
    • source (facultatif) : manual ou auto
  • /wp-json/seopress/v1/posts/[postId]/indexing-history : les 20 dernières soumissions d’un contenu, remplacez [postId] par l’ID du post

Méthodes disponibles : GET, et DELETE sur /instant-indexing/history pour vider tout l’historique.

Vous obtiendrez en réponse un JSON contenant les informations suivantes :

{
    "items": [
        {
            "id": 42,
            "url": "https://example.com/my-post/",
            "post_id": 123,
            "engine": "indexnow",
            "source": "auto",
            "status_code": 200,
            "success": true,
            "message": "",
            "date_gmt": "2026-10-28T09:15:00+00:00",
            "date": "28 octobre 2026 9 h 15"
        }
    ],
    "total": 1,
    "total_pages": 1,
    "max_rows": 5000
}

engine vaut indexnow ou google. La route par contenu renvoie items, ainsi que automatic (soumission automatique activée ou non) et history_url (le lien vers l’onglet Historique, vide pour un utilisateur qui ne peut pas l’ouvrir). L’historique conserve par défaut les 5 000 lignes les plus récentes, une ligne par URL et par moteur de recherche. Modifiez ce nombre avec le filtre seopress_instant_indexing_history_max_rows ; 0 arrête l’enregistrement.

Obtenir les redirections

Depuis SEOPress 8.8, vous pouvez obtenir la liste des redirections de SEOPress via notre API REST.

Notez que pour des raisons de sécurité, vous devez être connecté avec un utilisateur disposant de la capacité read_redirection.

1 route est actuellement disponible :

  • /wp-json/seopress/v1/redirections : pour obtenir toutes les redirections, liste des arguments ci-dessous :
    • id (facultatif) : integer, ID de la redirection
    • enabled (facultatif) : string, yes ou no
    • type (facultatif) : tableau des types de redirections, 301, 302, 307, 404, 410, 451

Méthode disponible : GET.

Vous obtiendrez en réponse un JSON contenant les informations suivantes :

{
  "success": true,
  "data": {
    "1681": {
      "origin": "my-origin-redirect",
      "destination": "https://www.seopress.org/redirect",
      "enabled": "yes",
      "type": "301",
      "param": "",
      "enabled_regex": "",
      "logged_status": "",
      "ip": "",
      "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/136.0.0.0 Safari/537.36",
      "full_origin": "",
      "date_request": "",
      "count": "14",
      "redirect_date_request": "1747125367"
    }
  }
}

Obtenir les rapports Search Console des posts

Depuis SEOPress 5.7, vous pouvez demander les rapports de Google Search Console de vos posts en utilisant notre REST API.

Notez que pour des raisons de sécurité, vous devez être connecté avec un utilisateur disposant de la capacité edit_post.

1 route est actuellement disponible :

  • /wp-json/seopress/v1/posts/[postID]/inspect : remplacer [postID] par l’ID du post

Méthodes disponibles : GET, POST.

Vous obtiendrez en réponse un JSON contenant les informations suivantes :

{
    "google_api_key_is_empty": false,
    "data": {
        "inspectionResult": {
            "inspectionResultLink": "https://search.google.com/search-console/inspect?resource_id=https://example.com/&id=xxxxxxxx&utm_medium=link&utm_source=api",
            "indexStatusResult": {
                "coverageState": "Indexed, not submitted in sitemap",
                "crawledAs": "MOBILE",
                "googleCanonical": "https://example.com/",
                "indexingState": "INDEXING_ALLOWED",
                "lastCrawlTime": "2022-04-29T13:25:27Z",
                "pageFetchState": "SUCCESSFUL",
                "referringUrls": [
                    "https://www.example.com/"
                ],
                "robotsTxtState": "ALLOWED",
                "sitemap": null,
                "userCanonical": "https://example.com/",
                "verdict": "PASS"
            },
            "mobileUsabilityResult": {
                "verdict": "PASS"
            },
            "richResultsResult": {
                "verdict": "PASS",
                "detectedItems": [
                {
                    "richResultType": "Logos",
                    "items": [
                    {
                        "name": "Unnamed item"
                    }
                    ]
                },
                {
                    "richResultType": "Sitelinks searchbox",
                    "items": [
                        {
                            "name": "Unnamed item"
                        }
                        ]
                    }
                ]
            }
        }
    }
}

Récupérer l’analyse de contenu

Depuis SEOPress 5.0 | Free

/wp-json/seopress/v1/posts/[postId]/content-analysis

Méthode : GET

Lance une analyse de contenu complète sur l’article donné et retourne les vérifications SEO détaillées (liens internes, liens sortants, score, utilisation des mots-clés, etc.).

Depuis SEOPress 10.4, la réponse contient aussi score_summary : le nombre de vérifications réussies, échouées et exécutées (passed, failed, total), sans les vérifications ignorées. C’est le ratio affiché dans la colonne Score. score donne désormais l’impact de chaque vérification, indexé par vérification, au lieu de la liste des impacts distincts. Un rôle coché dans Analyse du contenu : rôles bloqués ne peut pas demander l’analyse.

Paramètres

Argument Description
<postId> L’identifiant de l’article.
[target_keywords] Optionnel. Mots-clés séparés par des virgules à analyser. Si omis, utilise les mots-clés enregistrés en base de données.

Capacité requise : edit_post

Enregistrer l’analyse de contenu

Depuis SEOPress 5.0 | Free

/wp-json/seopress/v1/posts/[postId]/content-analysis

Méthode : POST

Enregistre les données d’analyse de contenu (liens internes, liens sortants et score) pour un article.

Corps JSON

{
    "score": "good",
    "internal_links": ["https://example.com/page1", "https://example.com/page2"],
    "outbound_links": ["https://external.com/page1"]
}

Paramètres

Argument Description
<postId> L’identifiant de l’article.

Capacité requise : edit_post

Récupérer les alertes SEO

Depuis SEOPress PRO 9.7 | PRO

/wp-json/seopress/v1/alerts

Méthode : GET

Retourne l’état en temps réel des trois vérifications d’alertes SEO : détection du noindex sur la page d’accueil, accessibilité du robots.txt et accessibilité du sitemap XML. Les résultats sont mis en cache pendant 5 minutes.

Exemples

  • Récupérer les alertes SEO : /wp-json/seopress/v1/alerts
  • Forcer une vérification (contourne le cache) : /wp-json/seopress/v1/alerts?force=true

Paramètres

Argument Description
[force] Booléen. Contourne le cache et force une vérification. Par défaut : false. Limité à une fois par utilisateur toutes les 60 secondes.

Réponse

{
    "homepage_noindex": {
        "status": "ok",
        "checked_url": "https://example.com",
        "noindex_found": false
    },
    "robots_txt": {
        "status": "ok",
        "checked_url": "https://example.com/robots.txt",
        "http_code": 200
    },
    "xml_sitemap": {
        "status": "error",
        "checked_url": "https://example.com/sitemaps.xml",
        "http_code": 404
    },
    "timestamp": "2026-03-31T12:00:00+00:00"
}

Capacité requise : manage_options

Récupérer les schémas automatiques

Depuis SEOPress PRO 9.7 | PRO

/wp-json/seopress/v1/schemas

Méthode : GET

Retourne tous les modèles de schémas automatiques (données structurées) configurés dans SEOPress.

Exemples

  • Récupérer tous les schémas : /wp-json/seopress/v1/schemas
  • Filtrer par type de schéma : /wp-json/seopress/v1/schemas?type=faq

Paramètres

Argument Description
[type] Filtrer les schémas par type. Valeurs acceptées : articles, localbusiness, faq, howto, courses, recipes, jobs, videos, events, products, softwareapp, services, review, custom.

Réponse

{
    "data": [
        {
            "id": 123,
            "title": "My FAQ Schema",
            "type": "faq",
            "rules": [...],
            "meta": {
                "_seopress_pro_rich_snippets_faq_...": "..."
            }
        }
    ],
    "total": 1
}

Capacité requise : edit_schemas

Récupérer un schéma automatique

/wp-json/seopress/v1/schemas/[schemaId]

Méthode : GET

Retourne un modèle de schéma automatique par son identifiant.

Paramètres

Argument Description
<schemaId> L’identifiant du schéma.

Capacité requise : edit_schema

Créer un schéma automatique

/wp-json/seopress/v1/schemas

Méthode : POST

Crée un nouveau modèle de schéma automatique.

Corps JSON

{
    "title": "My FAQ Schema",
    "type": "faq",
    "rules": [...],
    "meta": {
        "_seopress_pro_rich_snippets_faq_...": "..."
    }
}

Paramètres

Argument Description
<title> Le titre du schéma. Requis.
<type> Le type de schéma. Requis. Valeurs acceptées : articles, localbusiness, faq, howto, courses, recipes, jobs, videos, events, products, softwareapp, services, review, custom.
[rules] Règles de ciblage (types de contenu, taxonomies, etc.). Optionnel.
[meta] Valeurs des métadonnées du schéma. Les clés doivent commencer par _seopress_pro_rich_snippets_. Optionnel.

Capacité requise : publish_schemas

Mettre à jour un schéma automatique

/wp-json/seopress/v1/schemas/[schemaId]

Méthode : PUT

Met à jour un modèle de schéma automatique existant.

Paramètres

Argument Description
<schemaId> L’identifiant du schéma.
[title] Le titre du schéma.
[type] Le type de schéma.
[rules] Règles de ciblage.
[meta] Valeurs des métadonnées du schéma.

Capacité requise : edit_schema

Supprimer un schéma automatique

/wp-json/seopress/v1/schemas/[schemaId]

Méthode : DELETE

Supprime un modèle de schéma automatique.

Paramètres

Argument Description
<schemaId> L’identifiant du schéma.

Capacité requise : delete_schema

Récupérer les schémas manuels d’un article

Depuis SEOPress PRO 5.0 | PRO

/wp-json/seopress/v1/posts/[postId]/schemas-manual

Méthode : GET

Retourne les rich snippets manuels (données structurées) configurés pour un article spécifique, ainsi que les types de schémas disponibles et leurs champs.

Paramètres

Argument Description
<postId> L’identifiant de l’article.

Capacité requise : edit_post

Envoyer les schémas manuels d’un article

/wp-json/seopress/v1/posts/[postId]/schemas-manual

Méthode : PUT

Met à jour les rich snippets manuels d’un article spécifique.

Corps JSON

{
    "schemas": [
        {
            "_seopress_pro_rich_snippets_type": "faq",
            "_seopress_pro_rich_snippets_faq": [...]
        }
    ]
}

Paramètres

Argument Description
<postId> L’identifiant de l’article.

Capacité requise : edit_post

Récupérer les données du sitemap vidéo d’un article

Depuis SEOPress PRO 5.0 | PRO

/wp-json/seopress/v1/posts/[postId]/video-sitemap

Méthode : GET

Retourne les données du sitemap vidéo pour un article spécifique, incluant toutes les entrées vidéo et leurs champs (URL, titre, description, miniature, durée, note, etc.).

Paramètres

Argument Description
<postId> L’identifiant de l’article.

Capacité requise : edit_post

Envoyer les données du sitemap vidéo d’un article

Depuis SEOPress PRO 5.1

/wp-json/seopress/v1/posts/[postId]/video-sitemap

Méthode : PUT

Met à jour les données du sitemap vidéo pour un article spécifique.

Corps JSON

{
    "_seopress_video_disabled": false,
    "videos": [
        {
            "url": "https://www.youtube.com/watch?v=xxxxx",
            "title": "My Video Title",
            "desc": "My video description",
            "thumbnail": "https://example.com/thumb.jpg",
            "duration": 120,
            "rating": 4.5,
            "tag": "seo, wordpress",
            "family_friendly": false,
            "internal_video": false,
            "view_count": 1500
        }
    ]
}

Paramètres

Argument Description
<postId> L’identifiant de l’article.

Capacité requise : edit_post

Récupérer les paramètres Google News d’un article

Depuis SEOPress PRO 5.0 | PRO

/wp-json/seopress/v1/posts/[postId]/google-news-settings

Méthode : GET

Retourne les paramètres du sitemap Google News pour un article spécifique.

Paramètres

Argument Description
<postId> L’identifiant de l’article.

Capacité requise : edit_post

Envoyer les paramètres Google News d’un article

Depuis SEOPress PRO 5.1

/wp-json/seopress/v1/posts/[postId]/google-news-settings

Méthode : PUT

Met à jour les paramètres du sitemap Google News pour un article spécifique.

Corps JSON

{
    "_seopress_news_disabled": "yes"
}

Paramètres

Argument Description
<postId> L’identifiant de l’article.
<_seopress_news_disabled> Définir à « yes » pour exclure l’article du sitemap Google News. Omettre ou définir à toute autre valeur pour l’inclure.

Capacité requise : edit_post

Générer des métadonnées SEO avec l’IA

Depuis SEOPress PRO 5.0 | PRO

/wp-json/seopress/v1/posts/[postId]/generate-metas-by-ai

Méthode : POST

Génère un titre SEO et une méta description pour un article à l’aide de l’IA.

Exemples

  • Générer des métadonnées en français : POST /wp-json/seopress/v1/posts/123/generate-metas-by-ai {"lang": "fr_FR"}

Paramètres

Argument Description
<postId> L’identifiant de l’article.
[lang] Langue/locale pour la génération. Optionnel. Par défaut : locale du site (ex. fr_FR).

Capacité requise : edit_post

Générer des métadonnées sociales avec l’IA

Depuis SEOPress PRO 9.4 | PRO

/wp-json/seopress/v1/posts/[postId]/generate-social-metas-by-ai

Méthode : POST

Génère des balises méta pour les réseaux sociaux (Open Graph ou Twitter) pour un article à l’aide de l’IA.

Exemples

  • Générer un titre Facebook en anglais : POST /wp-json/seopress/v1/posts/123/generate-social-metas-by-ai {"platform": "facebook", "meta_type": "title", "lang": "en_US"}

Paramètres

Argument Description
<postId> L’identifiant de l’article.
<platform> La plateforme sociale. Valeurs acceptées : « facebook », « twitter ».
<meta_type> Quelle métadonnée générer. Valeurs acceptées : « title », « desc ».
[lang] Langue/locale pour la génération. Optionnel. Par défaut : locale du site.

Capacité requise : edit_post

Récupérer les suggestions de mots-clés significatifs

Depuis SEOPress PRO 5.0 | PRO

/wp-json/seopress/v1/posts/[postId]/significant-keywords

Méthode : GET

Retourne des suggestions de mots-clés basées sur l’analyse du contenu de l’article.

Paramètres

Argument Description
<postId> L’identifiant de l’article.

Réponse

{
    "suggestions": [
        {"keyword": "seo", "count": 12, "density": 2.5},
        {"keyword": "wordpress", "count": 8, "density": 1.7}
    ]
}

Capacité requise : edit_post

Obtenir les problèmes SEO

Depuis SEOPress 8.2, vous pouvez obtenir vos problèmes de référencement (fonctionnalité d’Audit de site) en utilisant notre API REST.

Notez que pour des raisons de sécurité, vous devez être connecté avec un utilisateur disposant de la capacité manage_options.

2 routes sont actuellement disponibles :

  • /wp-json/seopress/v1/seo-issues/[postId] : pour obtenir les problèmes SEO du post, remplacer [postId] par le post ID souhaité
  • /wp-json/seopress/v1/seo-issues/ pour obtenir tous les problèmes, liste des arguments disponibles ci-dessous :
    • id (facultatif) : ID du post
    • ignore (facultatif) : booléen (1 ou 0)
    • type (facultatif) : all_canonical, json_schemas, old_post, permalink, headings, title, description, social, robots, img_alt, nofollow_links, outbound_links, internal_links
    • priority (facultatif) : high, medium, low, good
    • name (facultatif) : json_schemas_duplicated, json_schemas_not_found, old_post, keywords_permalink, headings_not_found, headings_h1_duplicated, headings_h1_not_found, headings_h1_without_target_kw, headings_h2_without_target_kw, headings_h3_without_target_kw, title_without_target_kw, title_too_long, title_not_custom, description_without_target_kw, description_too_long, description_not_custom, og_title_duplicated, og_title_empty, og_title_missing, og_desc_duplicated, og_desc_empty, og_desc_missing, og_img_empty, og_img_missing, og_url_duplicated, og_url_empty, og_url_missing, og_sitename_duplicated, og_sitename_empty, og_sitename_missing, x_title_duplicated, x_title_empty, x_title_missing, x_desc_duplicated, x_desc_empty, x_desc_missing, x_img_empty, x_img_missing, meta_robots_duplicated, meta_robots_noindex, meta_robots_nofollow, meta_robots_noimageindex, meta_robots_nosnippet, meta_robots_nositelinkssearchbox, img_alt_missing, img_alt_no_media, nofollow_links_too_many, outbound_links_missing, internal_links_missing, canonical_duplicated, canonical_missing

Méthode disponible : GET.

Vous obtiendrez une réponse JSON avec les informations suivantes :

{
    "success": true,
    "data": [
        {
            "id": "1",
            "post_id": "1",
            "issue_name": "json_schemas_not_found",
            "issue_desc": "",
            "issue_type": "json_schemas",
            "issue_priority": "medium",
            "issue_ignore": "1"
        },
        {
            "id": "2",
            "post_id": "1",
            "issue_name": "keywords_permalink",
            "issue_desc": "",
            "issue_type": "permalink",
            "issue_priority": "medium",
            "issue_ignore": "0"
        },
        {
            "id": "3",
            "post_id": "1",
            "issue_name": "headings_h1_without_target_kw",
            "issue_desc": "",
            "issue_type": "headings",
            "issue_priority": "high",
            "issue_ignore": "0"
        }
    ];
}

Obtenir le rapport Google Page Speed

Depuis SEOPress 8.8, vous pouvez demander votre rapport Google Page Speed ​​via notre API REST.

Pour des raisons de sécurité, vous devez être connecté avec un compte utilisateur disposant de la fonctionnalité manage_options.

Une route est actuellement disponible :

  • /wp-json/seopress/v1/page-speed pour obtenir le rapport Google Page Speed. Liste des arguments disponibles ci-dessous :
    • device (facultatif) : mobile (par défaut) ou desktop

Méthode disponible : GET.

Vous recevrez une réponse JSON.

Obtenir les statistiques Google Analytics 4

Depuis SEOPress 8.8, vous pouvez demander vos statistiques Google Analytics 4 via notre API REST.

Pour des raisons de sécurité, vous devez être connecté avec un compte utilisateur disposant de la fonctionnalité edit_dashboard.

Une route est actuellement disponible :

  • /wp-json/seopress/v1/ga4 pour obtenir les statistiques Google Analytics 4

Méthode disponible : GET.

Vous recevrez une réponse JSON contenant toutes les statistiques par date.

Obtenir les statistiques Matomo Analytics

Depuis SEOPress 8.8, vous pouvez demander vos statistiques Matomo Analytics via notre API REST.

Pour des raisons de sécurité, vous devez être connecté avec un compte utilisateur disposant de la fonctionnalité edit_dashboard.

Une route est actuellement disponible :

  • /wp-json/seopress/v1/matomo pour obtenir les statistiques Matomo Analytics

Méthode disponible : GET.

Vous recevrez une réponse JSON contenant toutes les statistiques par date.

Depuis SEOPress PRO 10.4, lorsque la dernière synchronisation avec Matomo a échoué, la réponse en explique la raison au lieu d’être vide. reason vaut token_rejected, unreachable, unreadable ou other :

{
    "error": {
        "reason": "unreachable",
        "summary": "Your Matomo instance could not be reached.",
        "hint": "Check the Matomo URL, that the instance is up, and that its TLS certificate is valid.",
        "response": "",
        "time": 1761643200,
        "date": "28 octobre 2026 9 h 20"
    }
}

Obtenir les positions de mots clés via SEOPress Insights

Depuis SEOPress Insights 2.0, vous pouvez obtenir votre classement par mots-clés en utilisant notre API REST.

Notez que pour des raisons de sécurité, vous devez être connecté avec un utilisateur disposant de la capacité manage_options.

1 route est actuellement disponible :

  • /wp-json/seopress-insights/v1/rankings, liste des arguments disponibles ci-dessous :
    • kws (facultatif) : tableau d’IDs de mots clés
    • cpt (facultatif) : string, seopress_rankings
    • dates (facultatif) : tableau de timestamp

Méthode disponible : GET.

Vous obtiendrez une réponse JSON avec les informations suivantes :

{
    "2025/02/17": [
        {
            "keyword": "your keyword",
            "p": 18,
            "url": "https://www.seopress.org/example",
            "search_volume": 2900,
            "cpc": 4.1100000000000003,
            "competition": 0.13,
            "date": 1739760053,
            "added": 1634064757,
            "id": 7389
        }
    ],
}

Obtenir les concurrents via SEOPress Insights

Depuis SEOPress Insights 2.0, vous pouvez obtenir la liste de vos concurrents occupant la première position des mots clés suivis en utilisant notre API REST.

Notez que pour des raisons de sécurité, vous devez être connecté avec un utilisateur disposant de la capacité manage_options.

1 route est actuellement disponible :

  • /wp-json/seopress-insights/v1/competitors, liste des arguments disponibles ci-dessous :
    • kws (facultatif) : tableau d’IDs de mots clés
    • cpt (facultatif) : string, seopress_p1_rankings
    • dates (facultatif) : tableau de timestamp

Méthode disponible : GET.

Vous obtiendrez une réponse JSON avec les informations suivantes :

{
    "2025/02/17": [
        {
            "keyword": "your keyword",
            "p": 18,
            "url": "https://www.example.com/my-competitor",
            "search_volume": 2900,
            "cpc": 4.1100000000000003,
            "competition": 0.13,
            "date": 1739760053,
            "added": 1634064757,
            "id": 7389
        }
    ],
}

Depuis SEOPress Insights 2.0, vous pouvez obtenir la liste de vos liens retours en utilisant notre API REST.

Notez que pour des raisons de sécurité, vous devez être connecté avec un utilisateur disposant de la capacité manage_options.

1 route est actuellement disponible :

  • /wp-json/seopress-insights/v1/backlinks

Méthode disponible : GET.

Vous obtiendrez une réponse JSON avec les informations suivantes :

[
    {
        "backlink": "https://example.com/seopress",
        "acr_rank": 1,
        "anchor_text": "visit website",
        "source_title": "SEOPress",
        "source_out_domains_ext": "2",
        "source_out_links_ext": "3",
        "source_out_links_int": "6",
        "source_language": "en",
        "source_language_desc": "English",
        "source_language_conf": 99,
        "flag_redirect": 0,
        "flag_frame": 0,
        "flag_no_follow": 1,
        "flag_images": 0,
        "flag_deleted": 0,
        "flag_alt_text": 0,
        "flag_mention": 0,
        "target_url": "https://www.seopress.org/",
        "indirect_target_url": "",
        "indirect_target_type": "",
        "target_title": "SEOPress - The Best SEO Tools for WordPress in 2025",
        "target_language": "en",
        "target_language_desc": "English",
        "target_language_conf": 99,
        "links_root_domain": -1,
        "domain_id": 3245,
        "first_indexed_date": "2025-02-19",
        "last_seen_date": "2025-02-19",
        "date_lost": "",
        "reason_lost": "",
        "link_type": "TextLink",
        "link_sub_type": "TextLink_Normal",
        "target_citation_flow": 42,
        "target_trust_flow": 28,
        "target_topical_tf": "Business",
        "target_topical_tf_value": 27,
        "source_cf": 9,
        "source_tf": 0,
        "source_topical_tf": "",
        "source_topical_tf_value": "",
        "source_topical_tf_1": "",
        "source_topical_tf_value_1": "",
        "source_topical_tf_2": "",
        "source_topical_tf_value_2": "",
        "date": false
    },
]

Récupérer le tableau de bord Insights

Retourne les données du tableau de bord : synthèse d’indicateurs, tendance des positions, plus fortes hausses et baisses, distribution des positions, mots-clés favoris et résumé des backlinks.

GET /wp-json/seopress-insights/v1/dashboard

Ajoute un lien que l’import Majestic n’a pas trouvé, par exemple un partenariat ou un article invité. Seul source_url est obligatoire.

POST /wp-json/seopress-insights/v1/backlinks/manual

{
  "source_url": "https://exemple.com/blog/article",
  "target_url": "https://votre-site.com/page",
  "anchor_text": "votre ancre",
  "source_language": "fr",
  "flag_no_follow": false,
  "source_cf": 30,
  "source_tf": 25,
  "first_indexed_date": "2026-08-01",
  "source_topical_tf": "Computers/Internet"
}

Toutes les routes Insights exigent la capacité Insights correspondante. Consultez les capacités utilisateurs SEOPress & Insights.