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

Débuter avec l’API REST SEOPress

Obtenir les métadonnées des posts

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

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"
    },
    "twitter": {
        "title": "My Twitter title",
        "description": "My Twitter description",
        "image": "https://example.com/seopress-best-wordpress-seo-plugin.jpg"
    },
    "robots": {
        "noindex": false,
        "nofollow": false,
        "noodp": false,
        "noarchive": false,
        "nosnippet": false,
        "noimageindex": false
    }
}

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.

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"
    },
    "twitter": {
        "title": "My Twitter term title",
        "description": "My Twitter term description",
        "image": "https://example.com/term-seopress-best-wordpress-seo-plugin.jpg"
    },
    "robots": {
        "noindex": false,
        "nofollow": false,
        "noodp": false,
        "noarchive": false,
        "nosnippet": false,
        "noimageindex": false
    }
}

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 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_posts.

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