Saltar al contenido Saltar a la navegación
De vuelta al soporte principal

Comience con la API REST de SEOPress

Obtener metadatos de publicaciones

Desde SEOPress 5.0, puede solicitar sus metadatos de SEO utilizando nuestra API REST.

Actualmente hay 2 rutas disponibles:

  • /wp-json/seopress/v1/posts/[postId]: reemplaza [postId] por el ID de tu publicación
  • /wp-json/seopress/v1/posts/by-url?url=https://example.com/seopress-best-wordpress-seo-plugin/ reemplace la URL por el enlace permanente deseado

Método disponible: GET.

Obtendrá en respuesta un JSON con la siguiente información:

{ 
    "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, 
        "noarchive": 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/"
    }
}

Para solicitar sus datos, puede utilizar, por ejemplo, la API HTTP de WordPress.

Obtener metadatos de términos

Desde SEOPress 5.5, puede obtener metadatos de SEO para sus términos de taxonomía utilizando nuestra API REST.

Actualmente hay 2 rutas disponibles:

  • /wp-json/seopress/v1/terms/[termId] : reemplace [termId] con su ID de término
  • /wp-json/seopress/v1/terms/[termId]?taxonomy=[yourCustomTaxonomy] similar a la ruta anterior, con taxonomía como argumento (predeterminado: “categoría” si no se proporciona)

Método disponible: GET.

Obtendrá en respuesta un JSON con la siguiente información:

{ 
    "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, 
        "noarchive": 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/"
    }
}

Obtener la configuración de SEOPress

Desde SEOPress 5.5, puede solicitar configuraciones globales de SEOPress a través de nuestra API REST.

Tenga en cuenta que, por razones de seguridad, debe iniciar sesión con un usuario con la capacidad de manage_options.

Actualmente hay 10 rutas disponibles:

  • /wp-json/seopress/v1/options/dashboard-settings: Configuración del panel
  • /wp-json/seopress/v1/options/titles-settings: Títulos y metaconfiguraciones
  • /wp-json/seopress/v1/options/social-settings: Configuración de redes sociales
  • /wp-json/seopress/v1/options/sitemaps-settings: Configuración de mapas de sitio
  • /wp-json/seopress/v1/options/analytics-settings: Ajustes de medición y análisis estadístico
  • /wp-json/seopress/v1/options/advanced-settings: Ajustes avanzados
  • /wp-json/seopress/v1/options/bot-settings: Configuración de bots
  • /wp-json/seopress/v1/options/indexing-settings: Configuración de indexación instantánea
  • /wp-json/seopress/v1/options/license-settings: Configuración de licencia
  • /wp-json/seopress/v1/options/pro-settings: Configuración PRO

Método disponible: GET.

Obtendrá en respuesta un JSON con la siguiente información:

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

Obtener informes de publicaciones de Search Console

Desde SEOPress 5.7, puede solicitar informes de Google Search Console de sus publicaciones utilizando nuestra API REST.

Tenga en cuenta que, por razones de seguridad, debe iniciar sesión con un usuario con la capacidad edit_posts.

1 ruta está disponible actualmente:

  • /wp-json/seopress/v1/posts/[postID]/inspect : reemplace [postID] con el ID de la publicación

Método disponible: GET.

Obtendrá como respuesta un JSON que contiene la siguiente información:

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