API de Blogger JSON: Cómo usar la API

Importante: El 30 de septiembre de 2024 se descontinuará la compatibilidad con la API de JSON v2.0. Para garantizar una funcionalidad continua, actualiza las aplicaciones que usan la API de JSON v2.0 a la versión más reciente de la API. Para acceder a la versión más reciente, utiliza los vínculos en 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 Blogger JSON. Blogger es una herramienta para crear sitios web que permitan a las personas publicar sus ideas de forma continua.

Si no conoces los conceptos de Blogger, lee la sección Cómo comenzar antes de comenzar a escribir código.

Identifica tu aplicación y autoriza solicitudes

Cada solicitud que tu aplicación envía a la API de Blogger JSON debe identificar tu aplicación ante Google. Hay dos maneras 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. Sigue estos pasos para determinar cuáles de estas opciones debes usar:

  • Si la solicitud requiere autorización (como una solicitud de datos privados de una persona), entonces la aplicación debe proporcionar un token de OAuth 2.0 con la solicitud. La aplicación también puede proporcionar la clave de API, pero no es necesario.
  • Si la solicitud no requiere autorización (como una solicitud de datos públicos), la aplicación debe proporcionar la clave de API o un token de OAuth 2.0, o ambos, 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 el acceso al mismo tiempo que se solicita acceso a los datos (híbrido) o la delegación de autoridad en todo el dominio (2LO).

Autoriza solicitudes con OAuth 2.0

Las solicitudes a la API de JSON de Blogger para datos de usuarios no públicos deben contar con la autorización de un usuario autenticado.

Los detalles del proceso de autorización, o “flujo”, para OAuth 2.0 varían de alguna manera según el 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 en Google. Luego, Google te proporcionará la información que necesitarás más adelante, como un ID y un secreto del cliente.
  2. Activa la API de Blogger JSON en el panel de servicios de la Consola de APIs de Google. (si no aparece en la lista de la consola, omite este paso).
  3. Cuando tu aplicación necesite acceder a datos del usuario, solicita a Google un alcance de acceso en particular.
  4. Google le mostrará un diálogo de OAuth al usuario, en el que le pedirá que autorice a tu aplicación para solicitar algunos de sus datos.
  5. Si el usuario la aprueba, Google le otorgará a tu aplicación un token de acceso de corta duración.
  6. Tu aplicación solicita datos del usuario y adjunta el token de acceso a la solicitud.
  7. Si Google determina que tu solicitud y el token son válidos, mostrará los datos solicitados.

Algunos flujos incluyen pasos adicionales, como el uso de tokens de actualización, 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.

Esta es la información de alcance de OAuth 2.0 para la API de Blogger JSON:

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

Para solicitar acceso con OAuth 2.0, tu aplicación necesita la información del alcance, además de la información que Google proporciona durante el registro de la aplicación (como el ID o 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. Consulta la página Bibliotecas y muestras para obtener más detalles.

Adquiere y usa una clave de API

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

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

A continuación, ve al panel Acceso a la API. La clave de API se encuentra cerca de la parte inferior de ese panel, en la sección denominada "Simple API Access".

Una vez que tengas una clave de API, tu aplicación podrá agregar 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

Si quieres obtener información para un recurso de blogs en particular, envía una solicitud GET HTTP 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 autenticar a un usuario para que recupere 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 tiene blogs privados, que requieren autenticación.

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

Para recuperar una lista de los blogs de un usuario, envía una solicitud GET HTTP al URI de Blogs Collection:

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

Solicitud

A continuación, se muestra un ejemplo de una solicitud GET que enumera los blogs de un usuario:

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

Nota: El usuario debe estar autenticado para que muestre sus propios blogs, por lo que debes proporcionar el encabezado 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 entradas de un blog

Para recuperar una lista de entradas de un blog determinado, envía una solicitud GET al URI de la colección de entradas. El URI de una colección de publicaciones 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

Dado que no es necesario autenticar a un usuario para recuperar las entradas de 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 tiene blogs privados, que 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 entrada específica de un blog, envía una solicitud GET al URI del recurso de las entradas. El URI de un recurso de publicaciones 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

Dado que no es necesario autenticar a un usuario para recuperar las entradas de 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 tiene blogs privados, que requieren autenticación.

Respuesta

Si la solicitud se realiza correctamente, el servidor responde con un código de estado HTTP 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 los comentarios de una publicación

Para recuperar una lista de comentarios de una entrada, envía una solicitud GET al URI de la colección de comentarios. El URI de una colección de 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

Dado que no es necesario autenticar a un usuario para recuperar los comentarios de 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 tiene blogs privados, que 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 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 entrada, 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

Dado que no es necesario autenticar a un usuario para recuperar los comentarios de 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 tiene blogs privados, que requieren autenticación.

Respuesta

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

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 de un blog

Para recuperar 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 colección de páginas 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

Dado que no es necesario autenticar a un usuario para recuperar las páginas de un blog público, no necesitas 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 tiene blogs privados, que 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 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"
        }
      }
    }
  ]
}

Cómo recuperar una página específica

Para recuperar una página específica de un blog, envía una solicitud GET al URI de recurso de las páginas. El URI de un recurso de páginas 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

Dado que no es necesario autenticar a un usuario para recuperar las páginas de un blog público, no necesitas 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 tiene blogs privados, que requieren autenticación.

Respuesta

Si la solicitud se realiza correctamente, el servidor responde con un código de estado HTTP 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

Cómo recuperar un usuario

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

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

Solicitud

A continuación, se muestra un ejemplo de una solicitud GET que enumera los blogs de un usuario:

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

Nota: El usuario debe estar autenticado para que muestre 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 un código de estado HTTP 200 OK y un vínculo a una lista de los blogs del usuario:

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 recursos en 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.