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"
}

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"
}

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
    }
}

Obtenir les métadonnées des posts

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

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

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.

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

{ 
    "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.

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

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.

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

{ 
    "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.

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 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éthode disponible : GET.

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"
                        }
                        ]
                    }
                ]
            }
        }
    }
}

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.

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
    },
]