API de Blogger JSON: Cómo usar la API

Importante: Daremos de baja la compatibilidad con la API de JSON v2.0 el 30 de septiembre de 2024. Para garantizar la funcionalidad continua, actualiza las aplicaciones que dependen de la API de JSON v2.0 a la versión más reciente de la API. Para obtener la versión más reciente, usa los vínculos de la barra de navegación de la izquierda.

En este documento, se describe cómo usar las funciones comunes de la API de JSON de Blogger con el estilo de llamada RESTful.

Contenido

Introducción

Este documento está dirigido a desarrolladores que deseen escribir aplicaciones que puedan interactuar con la API de JSON de Blogger. Blogger es una herramienta para crear sitios web que permiten que las personas publiquen sus pensamientos de forma continua.

Si no conoces los conceptos de Blogger, lee Cómo comenzar antes de comenzar a codificar.

Cómo autorizar solicitudes y cómo identificar tu aplicación

Cada solicitud que tu aplicación envía a la API de JSON de Blogger debe identificar tu aplicación ante Google. Hay dos formas de identificar tu aplicación: mediante un token de OAuth 2.0 (que también autoriza la solicitud) o mediante la clave de API de la aplicación. Aquí te mostramos cómo determinar cuál de esas opciones usa:

  • Si se requiere autorización para la solicitud (como una solicitud de datos privados de un individuo), se debe utilizar la aplicación a fin de proporcionar un token OAuth 2.0 con la solicitud. La aplicación también puede proporcionar la clave de API, pero no tiene a los que tiene acceso una cuenta.
  • Si la solicitud no requiere autorización (como una solicitud de datos), la aplicación debe proporcionar la clave de API o un OAuth 2.0 token, o ambos, sea la opción que te resulte más conveniente.

Acerca de los protocolos de autorización

Tu aplicación debe usar OAuth 2.0. para autorizar solicitudes. No se admiten otros protocolos de autorización.

Nota: Por el momento, la API de JSON de Blogger no admite registros. al mismo tiempo que se solicita acceso a datos (híbridos) o acceso a datos delegación de autoridad (2LO).

Solicitudes de autorización con OAuth 2.0

Se deben autorizar las solicitudes a la API de JSON de Blogger para datos del usuario que no son públicos por un usuario autenticado.

Los detalles del proceso de autorización, o “flujo”, para OAuth 2.0 varían depende del tipo de aplicación que escribas. El siguiente proceso general se aplica a todos los tipos de aplicación:

  1. Cuando creas tu aplicación, la registras con Google. Luego, Google proporcionará la información que necesitarás más adelante, como el ID y un secreto del cliente.
  2. Activa la API de JSON de Blogger en el panel de servicios de la Consola de APIs de Google. (Si no aparece en la consola, omite este paso).
  3. Cuando tu aplicación necesite acceder a datos del usuario, solicita a Google alcance particular del acceso.
  4. Google muestra al usuario un diálogo de OAuth en el que le solicita que autorice a tu aplicación para solicitar algunos de sus datos.
  5. Si el usuario la aprueba, Google le otorgará a la aplicación un token de acceso de corta duración.
  6. Tu aplicación solicita datos del usuario y adjunta el token de acceso al para cada solicitud.
  7. Si Google determina que tu solicitud y el token son válidos, muestra los datos solicitados.

Algunos flujos incluyen pasos adicionales, como el uso de Actualizar tokens para adquirir nuevos tokens de acceso. Si deseas obtener información detallada sobre los flujos para varios tipos de aplicaciones, consulta la documentación de OAuth 2.0 de Google.

A continuación, encontrarás información del alcance de OAuth 2.0 para el API de JSON de Blogger:

https://www.googleapis.com/auth/blogger

Para solicitar acceso con OAuth 2.0, tu aplicación necesita el permiso información, así como la información que Google proporciona durante la solicitud registro (como el ID o el secreto del cliente).

Sugerencia: Las bibliotecas cliente de las APIs de Google pueden controlar algunos de los procesos de autorización por ti. Están disponibles para una variedad de lenguajes de programación. Si quieres obtener más detalles, consulta la página Bibliotecas y ejemplos.

Adquiere y usa una clave de API

Las solicitudes a la API de JSON de Blogger para datos públicos deben incluir una identificador, que puede ser una clave de API o un token de autenticación.

Para obtener una clave de API, visita la Consola de APIs. En el panel Servicios, activa [api_name]. Si aparecen las Condiciones del Servicio, léelas y acéptalas.

Luego, ve a la página de la API Acceso. La clave de API se encuentra cerca de la parte inferior de ese panel, en la sección titulada "Simple API Access".

Una vez que tengas una clave de API, tu aplicación podrá adjuntar el parámetro de consulta key=yourAPIKey a todas las URLs de solicitud.

La clave de API en las URL se incorpora de manera segura, por lo que no necesita codificación.

Uso de blogs

Cómo recuperar un blog

Puedes recuperar información para un recurso de blogs en particular mediante el envío de un GET al URI del blog. El URI de un recurso de blogs tiene el siguiente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId

Solicitud

A continuación, se muestra un ejemplo:

GET https://www.googleapis.com/blogger/v2/blogs/2399953&key=YOUR-API-KEY

Dado que no es necesario que un usuario se autentique para recuperar un blog público, no tienes que proporcionar el encabezado HTTP Authorization con esta solicitud GET. Sin embargo, si no proporcionas ese encabezado, debes proporcionar una clave de API.

Blogger también cuenta con blogs privados, los cuales la autenticación de varios factores.

Respuesta

Si la solicitud se realiza correctamente, el servidor responde con un código de estado HTTP 200 OK y los datos del blog:

200 OK

{
  "kind": "blogger#blog",
  "id": "2399953",
  "name": "Blogger Buzz",
  "description": "The Official Buzz from Blogger at Google",
  "published": "2007-04-23T22:17:29.261Z",
  "updated": "2011-08-02T06:01:15.941Z",
  "url": "http://buzz.blogger.com/",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953",
  "posts": {
    "totalItems": 494,
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts"
  },
  "pages": {
    "totalItems": 2,
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/pages"
  },
  "locale": {
    "language": "en",
    "country": "",
    "variant": ""
  }
}

Cómo recuperar los blogs de un usuario

Puedes recuperar una lista de los blogs de un usuario si envías una solicitud GET HTTP. al URI de la Colección de blogs:

https://www.googleapis.com/blogger/v2/users/userId/blogs

Solicitud

Este es un ejemplo de una solicitud GET que enumera un blogs de usuarios:

GET https://www.googleapis.com/blogger/v2/users/self/blogs
Authorization: /* OAuth 2.0 token here */

Nota: El usuario debe autenticarse en enumerar sus propios blogs, por lo que debes proporcionar el HTTP Authorization con la solicitud GET.

Respuesta

Si la solicitud se realiza correctamente, el servidor responde con un código de estado HTTP 200 OK y la representación completa de la lista de los blogs del usuario:

200 OK

{
  "kind": "blogger#blogList",
  "items": [
    {
      "kind": "blogger#blog",
      "id": "4967929378133675647",
      "name": "Brett's Test Blawg",
      "description": "",
      "published": "2010-10-06T23:33:31.662Z",
      "updated": "2011-08-08T06:50:02.005Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647",
      "posts": {
        "totalItems": 13,
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/posts"
      },
      "pages": {
        "totalItems": 1,
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages"
      },
      "locale": {
        "language": "en",
        "country": "",
        "variant": ""
      }
    }
  ]
}

Cómo trabajar con publicaciones

Cómo recuperar publicaciones de un blog

Puedes recuperar una lista de entradas de un blog determinado enviando un GET al URI de la colección de publicaciones. El URI de una entrada La colección tiene el siguiente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts

Solicitud

A continuación, se muestra un ejemplo:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts&key=YOUR-API-KEY

Como no es necesario que un usuario esté autenticado para recuperar las entradas de un blog público, no debes proporcionar el encabezado HTTP Authorization con este GET solicitud; pero si no proporcionas ese encabezado, debes proporcionar una clave de API.

Blogger también tiene blogs privados, que sí requieren autenticación.

Respuesta

Si la solicitud se realiza correctamente, el servidor responde con un código de estado HTTP 200 OK y la lista de publicaciones:

200 OK

{
  "kind": "blogger#postList",
  "nextPageToken": "CgkIChiAkceVjiYQ0b2SAQ",
  "prevPageToken": "CgkIChDBwrK3mCYQ0b2SAQ",
  "items": [
    {
      "kind": "blogger#post",
      "id": "7706273476706534553",
      "blog": {
        "id": "2399953"
      },
      "published": "2011-08-01T19:58:00.000Z",
      "updated": "2011-08-01T19:58:51.947Z",
      "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553",
      "title": "Latest updates, August 1st",
      "content": "elided for readability",
      "author": {
        "id": "401465483996",
        "displayName": "Brett Wiltshire",
        "url": "http://www.blogger.com/profile/01430672582309320414",
        "image": {
          "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
         }
      },
      "replies": {
        "totalItems": "0",
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments"
      }
    },
    {
      "kind": "blogger#post",
      "id": "6069922188027612413",
      elided for readability
    }
  ]
}

Cómo recuperar una publicación específica

Para recuperar una publicación específica de un blog, envía una solicitud GET al URI del recurso de publicaciones. El URI de una entrada El recurso tiene el siguiente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId

Solicitud

A continuación, se muestra un ejemplo:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553&key=YOUR-API-KEY

Como no es necesario que un usuario esté autenticado para recuperar las entradas de un blog público, no debes proporcionar el encabezado HTTP Authorization con este GET solicitud; pero si no proporcionas ese encabezado, debes proporcionar una clave de API.

Blogger también tiene blogs privados, que sí requieren autenticación.

Respuesta

Si la solicitud se realiza correctamente, el servidor responde con una solicitud Código de estado de 200 OK y el contenido de la publicación:

200 OK

{
  "kind": "blogger#post",
  "id": "7706273476706534553",
  "blog": {
    "id": "2399953"
  },
  "published": "2011-08-01T19:58:00.000Z",
  "updated": "2011-08-01T19:58:51.947Z",
  "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553",
  "title": "Latest updates, August 1st",
  "content": "elided for readability",
  "author": {
    "id": "401465483996",
    "displayName": "Brett Wiltshire",
    "url": "http://www.blogger.com/profile/01430672582309320414",
    "image": {
      "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
    }
  },
  "replies": {
    "totalItems": "0",
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments"
  }
}

Cómo trabajar con comentarios

Cómo recuperar comentarios de una publicación

Para recuperar una lista de comentarios de una publicación, envía un Solicitud GET al URI de la colección de comentarios. El URI de un La colección Comentarios tiene el siguiente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments

Solicitud

A continuación, se muestra un ejemplo:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments&key=YOUR-API-KEY

Como no es necesario que un usuario esté autenticado para recuperar los comentarios de un blog público, no debes proporcionar el encabezado HTTP Authorization con este GET solicitud; pero si no proporcionas ese encabezado, debes proporcionar una clave de API.

Blogger también cuenta con blogs privados, los cuales la autenticación de varios factores.

Respuesta

Si la solicitud se realiza correctamente, el servidor responde con una solicitud Código de estado 200 OK y lista de comentarios:

200 OK

{
  "kind": "blogger#commentList",
  "nextPageToken": "CgkIFBDwjvDXlyYQ0b2SARj9mZe9n8KsnlQ",
  "prevPageToken": "CgkIFBisvMGRlyYQ0b2SARj9mZe9n8KsnlQ",
  "items": [
    {
       "kind": "blogger#comment",
       "id": "9200761938824362519",
       "post": {
         "id": "6069922188027612413"
       },
       "blog": {
         "id": "2399953"
       },
       "published": "2011-07-28T19:19:57.740Z",
       "updated": "2011-07-28T21:29:42.015Z",
       "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
       "content": "elided",
       "author": {
         "id": "530579030283",
         "displayName": "elided",
         "url": "elided",
         "image": {
           "url": "elided"
         }
       }
    },
    {
      "kind": "blogger#comment",
      "id": "400101178920857170",
      elided for readability
    }
  ]
}

Cómo recuperar un comentario específico

Para recuperar un comentario específico de una publicación, envía una solicitud GET al URI del recurso de comentarios. El URI de un recurso de comentarios tiene el siguiente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId

Solicitud

A continuación, se muestra un ejemplo:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519&key=YOUR-API-KEY

Como no es necesario que un usuario esté autenticado para recuperar los comentarios de un blog público, no debes proporcionar el encabezado HTTP Authorization con este GET solicitud; pero si no proporcionas ese encabezado, debes proporcionar una clave de API.

Blogger también cuenta con blogs privados, los cuales la autenticación de varios factores.

Respuesta

Si la solicitud se realiza correctamente, el servidor responde con una solicitud Código de estado 200 OK y datos de los comentarios:

200 OK

{
  "kind": "blogger#comment",
  "id": "9200761938824362519",
  "post": {
    "id": "6069922188027612413"
  },
  "blog": {
    "id": "2399953"
  },
  "published": "2011-07-28T19:19:57.740Z",
  "updated": "2011-07-28T21:29:42.015Z",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
  "content": "elided",
  "author": {
    "id": "530579030283",
    "displayName": "elided",
    "url": "elided",
    "image": {
      "url": "elided"
    }
  }
}

Cómo trabajar con páginas

Cómo recuperar páginas para un blog

Para obtener una lista de páginas de un blog, envía una solicitud GET al URI de la colección de páginas. El URI de una página La colección tiene el siguiente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/pages

Solicitud

A continuación, se muestra un ejemplo:

GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages&key=YOUR-API-KEY

Como no es necesario que un usuario esté autenticado para recuperar las Páginas de un blog público, puedes no debes proporcionar el encabezado HTTP Authorization con este GET solicitud; pero si no proporcionas ese encabezado, debes proporcionar una clave de API.

Blogger también tiene blogs privados, que sí requieren autenticación.

Respuesta

Si la solicitud se realiza correctamente, el servidor responde con una solicitud Código de estado 200 OK y la lista de páginas:

200 OK

{
  "kind": "blogger#pageList",
  "items": [
    {
      "kind": "blogger#page",
      "id": "273541696466681878",
      "blog": {
        "id": "4967929378133675647"
      },
      "published": "2011-07-14T16:16:00.000Z",
      "updated": "2011-07-14T16:16:23.602Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878",
      "title": "Static Content",
      "content": "elided for readability",
      "author": {
        "id": "901569848744",
        "displayName": "brett",
        "url": "http://www.blogger.com/profile/16258312240222542576",
        "image": {
          "url": "https://resources.blogblog.com/img/b16-rounded.gif"
        }
      }
    }
  ]
}

Recupera una página específica

Para recuperar una página específica de un blog, envía un GET al URI de recurso de Páginas. El URI de una página El recurso tiene el siguiente formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId

Solicitud

A continuación, se muestra un ejemplo:

GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878&key=YOUR-API-KEY

Como no es necesario que un usuario esté autenticado para recuperar las Páginas de un blog público, puedes no debes proporcionar el encabezado HTTP Authorization con este GET solicitud; pero si no proporcionas ese encabezado, debes proporcionar una clave de API.

Blogger también tiene blogs privados, que sí requieren autenticación.

Respuesta

Si la solicitud se realiza correctamente, el servidor responde con una solicitud Código de estado 200 OK y los datos de la página:

200 OK

{
  "kind": "blogger#page",
  "id": "273541696466681878",
  "blog": {
    "id": "4967929378133675647"
  },
  "published": "2011-07-14T16:16:00.000Z",
  "updated": "2011-07-14T16:16:23.602Z",
  "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878",
  "title": "Static Content",
  "content": "elided for readability",
  "author": {
    "id": "901569848744",
    "displayName": "brett",
    "url": "http://www.blogger.com/profile/16258312240222542576",
    "image": {
      "url": "https://resources.blogblog.com/img/b16-rounded.gif"
    }
  }
}

Cómo trabajar con usuarios

Recupera un usuario

Para recuperar la información de un usuario, envía una solicitud HTTP GET al URI del recurso de usuarios:

https://www.googleapis.com/blogger/v2/users/userId

Solicitud

Este es un ejemplo de una solicitud GET que enumera un blogs de usuarios:

GET https://www.googleapis.com/blogger/v2/users/self
Authorization: /* OAuth 2.0 token here */

Nota: El usuario debe estar autenticado para enumerar su propia información, por lo que debes proporcionar el encabezado HTTP Authorization con la solicitud GET.

Respuesta

Si la solicitud se realiza correctamente, el servidor responde con una solicitud 200 OK y un vínculo a una lista de las credenciales del usuario blogs:

200 OK

{
  "kind": "blogger#user",
  "id": "901569848744",
  "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744",
  "blogs": {
    "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744/blogs"
  }
}

Parámetros de búsqueda estándar

Los siguientes parámetros de consulta se pueden usar con todos los métodos y todos los recursos de las APIs de Blogger.

Los parámetros de consulta que se aplican a todas las operaciones de las APIs de Blogger se documentan en Parámetros del sistema: