API de Blogger JSON: Uso de la API

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

Contenido

Introducción

Este documento está dirigido a desarrolladores que desean escribir aplicaciones que pueden interactuar con la API de JSON de Blogger. Blogger es una herramienta para crear sitios web que permiten a los usuarios publicar sus pensamientos de forma continua.

Si no conoces los conceptos de Blogger, lee el artículo Cómo empezar antes de empezar a programar.

Cómo identificar solicitudes y autorizar solicitudes

Cada solicitud que tu aplicación envía a la API de JSON de Blogger debe identificar tu aplicación en Google. Hay dos formas de identificar tu aplicación: con 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 usar:

  • Si la solicitud requiere autorización (como una solicitud de datos privados de un individuo), 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, un token de OAuth 2.0 o ambos, lo 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 solicita acceso a los datos (híbrido) o la delegación de autoridad (2LO) de todo el dominio.

Autoriza solicitudes con OAuth 2.0

Las solicitudes a la API de JSON de Blogger para datos del usuario que no son públicos deben estar autorizadas por un usuario autenticado.

Los detalles del proceso de autorización, o flujo, para OAuth 2.0 varían en función del tipo de aplicación que estés escribiendo. El siguiente proceso general se aplica a todos los tipos de aplicaciones:

  1. Cuando creas tu aplicación, la registras en Google. Luego, Google proporciona la información que necesitarás más adelante, como un ID de cliente y un secreto del cliente.
  2. Activa la API de JSON de Blogger en el panel de servicios de la consola de las API de Google. (Si no aparece en Console, omita este paso).
  3. Cuando tu aplicación necesita acceder a los datos del usuario, solicita a Google un alcance de acceso en particular.
  4. Google le muestra al usuario un diálogo OAuth en el que le solicita autorizar 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 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.

A continuación, se muestra la información de alcance de OAuth 2.0 para la API de JSON de Blogger:

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

Para solicitar acceso con OAuth 2.0, tu aplicación necesita información sobre el alcance, además de la información que proporciona Google durante el registro de la aplicación (como el ID de cliente o el secreto del cliente).

Sugerencia: Las bibliotecas cliente de las API de Google pueden controlar parte del proceso de autorización por ti. Están disponibles para una variedad de lenguajes de programación. Consulta la página de bibliotecas y muestras para obtener más detalles.

Adquiere y usa una clave de API

Las solicitudes a la API de JSON de Blogger para datos públicos 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 API. En el panel de Servicios, activa [api_name]. Si aparecen las Condiciones del Servicio, léelas y acéptalas.

Luego, 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 titulada Acceso simple a la API.

Una vez que tengas una clave de API, tu aplicación podrá agregar el parámetro de búsqueda key=yourAPIKey a todas las URL 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 si envías 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 al usuario para recuperar un blog público, no es necesario proporcionar el encabezado HTTP Authorization con esta solicitud GET; pero 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": ""
  }
}

Recuperación de blogs de un usuario

Para recuperar una lista de los blogs de un usuario, envía una solicitud GET HTTP al URI de la colección de blogs:

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 autenticarse para mostrar sus propios blogs, por lo que debes proporcionar el encabezado HTTP Authorization con la solicitud GET.

Respuesta

Si la solicitud se realiza de forma correcta, el servidor responde con un código de estado HTTP 200 OK y la representación completa de la lista de 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

Puedes recuperar una lista de entradas de un blog determinado si envías una solicitud GET al URI de la colección de entradas. El URI de una colección de entradas 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 al usuario para recuperar las entradas de un blog público, no es necesario que proporciones 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 entradas:

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

Puedes recuperar una entrada específica de un blog si envías una solicitud GET al URI del recurso de entradas. El URI para un recurso de entradas 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 al usuario para recuperar las entradas de un blog público, no es necesario que proporciones 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 comentarios para una publicación

Puedes recuperar una lista de comentarios para una publicación si envías 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

Ya que no es necesario autenticarse para que los usuarios recuperen los comentarios de un blog público, no es necesario que proporciones 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 de forma correcta, 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

Puedes recuperar un comentario específico de una publicación si envías 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

Ya que no es necesario autenticarse para que los usuarios recuperen los comentarios de un blog público, no es necesario que proporciones 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 de forma correcta, 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 para un blog

Puedes recuperar una lista de páginas de un blog si envías una solicitud GET al URI de 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

Debido a que no es necesario autenticar al usuario para recuperar las páginas de un blog público, no es necesario 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 completa de forma correcta, 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

Puedes recuperar una página específica de un blog si envías una solicitud GET al URI del recurso de 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

Debido a que no es necesario autenticar al usuario para recuperar las páginas de un blog público, no es necesario 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 HTTP GET al URI del 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 mostrar su propia información, por lo que debes proporcionar el encabezado HTTP Authorization con la solicitud GET.

Respuesta

Si la solicitud se realiza de forma correcta, 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 API de Blogger.

Los parámetros de búsqueda que se aplican a todas las operaciones de las API de Blogger se documentan en Parámetros del sistema.