API de Blogger: Cómo comenzar

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

En este documento, se explica cómo comenzar a usar la API de Blogger.

Antes de comenzar

Crea una Cuenta de Google

Asegúrate de tener configurada una cuenta de Google. Te recomendamos que uses una Cuenta de Google separada para fines de desarrollo y prueba a fin de protegerte contra la pérdida accidental de datos. Si ya tienes una cuenta de prueba, no tienes que hacer nada más. Puedes visitar la interfaz de usuario de Blogger para configurar, editar o ver los datos de prueba.

Familiarízate con Blogger

Si no estás familiarizado con los conceptos de Blogger, lee este documento y experimenta con la interfaz de usuario antes de comenzar a programar. En este documento, se supone que estás familiarizado con Blogger, con conceptos de programación web y con formatos de datos web.

Obtén información sobre cómo autorizar solicitudes e identificar tu aplicación

Cuando tu aplicación solicita datos privados, la solicitud debe estar autorizada por un usuario autenticado que tenga acceso a esos datos.

Cuando tu aplicación solicita datos públicos, no es necesario autorizar la solicitud, pero sí debe ir acompañada de un identificador, como una clave de API.

Para obtener información sobre cómo autorizar solicitudes y usar claves de API, consulta Identifica y autoriza tu aplicación en el documento Uso de la API.

Fondo de Blogger API

Conceptos de Blogger

Blogger se basa en cinco conceptos básicos:

  • Blogs: El concepto raíz de la API. Un blog tiene entradas y páginas. Este es el contenedor de la metainformación del blog, como el nombre y la descripción.
  • Entradas: Una entrada de blog es el elemento que el autor puede publicar. Esta información debe ser oportuna, lo que refleja lo que los autores quieren publicar en el mundo ahora. Se entiende que con el tiempo, el contenido de entradas de blog pasa a ser más antiguo y se vuelve menos relevante.
  • Comentarios: Un comentario es el lugar donde las personas que no pertenecen al autor de la entrada de blog reaccionan a lo que escribió el autor. Desde ladrillos hasta ramos de flores.
  • Páginas: Una página es un lugar para contenido estático, como información biográfica, o las formas de comunicarse con el usuario. Por lo general, esta información es eterna y no cambia muy a menudo.
  • Usuarios: Un usuario es una persona que interactúa con Blogger, ya sea como autor, administrador o solo lector. En los blogs públicos, los lectores pueden ser anónimos, pero en los blogs privados, los lectores deben ser identificados por Blogger.

Modelo de datos de la API de Blogger

Un recurso es una entidad de datos individual con un identificador único. La API de JSON de Blogger opera en cinco tipos de recursos:

  • Recurso de Blogs: Representa un blog.
  • Recurso de entradas: Representa una entrada; cada recurso de entradas es un elemento secundario de un recurso de blogs.
  • Recurso de comentarios: Representa un comentario en una publicación específica; cada recurso de comentarios es un elemento secundario de un recurso de publicaciones.
  • Recurso de páginas: Representa una página estática; cada recurso de página es un elemento secundario de un recurso de blogs.
  • Recurso de usuarios: Representa a un usuario no anónimo. Se usa para identificar al autor de una página, una publicación o un comentario.
El recurso de blogs tiene dos tipos de recursos secundarios, páginas y entradas.
          Un recurso de publicaciones puede tener recursos secundarios de comentarios.
Descripción general de las relaciones entre los recursos

El modelo de datos de la API de Blogger se basa en grupos de recursos llamados colecciones:

Colección de Blogs
Una <span="apicollection">blogs Collection consta de todos los blogs a los que un usuario tiene derechos de acceso. Puedes enumerar blogs por usuario o recuperar un solo blog por ID.</span="apicollection">
Colección de publicaciones
Una colección de entradas consiste en todos los recursos de publicaciones dentro de un recurso de blogs específico.
Recopilación de comentarios
Una colección de comentarios consiste en todos los recursos de comentarios dentro de un recurso de publicaciones específico.
Colección de páginas
Una colección de páginas consta de todos los recursos de páginas dentro de un recurso de blogs específico.
Colección de usuarios
Una colección de usuarios consiste en todos los recursos de usuarios en Blogger y, por lo tanto, no se pueden enumerar. Un usuario puede recuperar su propio recurso de usuario (pero nadie más) por ID o por medio del identificador self.

Operaciones de la API de Blogger

Puedes invocar diferentes métodos en las colecciones y los recursos de la API de Blogger, como se describe en la siguiente tabla.

Operación Descripción Asignaciones HTTP de REST
list Muestra una lista de todos los recursos dentro de una colección. GET en un URI de colección
obtener Obtiene un recurso específico. GET en un URI de recurso.
getByUrl Obtiene un recurso y lo busca por URL. GET por la URL pasada como parámetro
getByPath Obtiene un recurso al buscarlo por su ruta de acceso. GET por la ruta que se pasó como parámetro.
listaDeUsuario Enumera los recursos que son propiedad de un usuario. GET en una colección que es propiedad del usuario
search Busca recursos según un parámetro de consulta. GET en una URL de búsqueda, con la consulta pasada como parámetro
insertar Crea un recurso en una colección. POST en un URI de colección
borrar Borra un recurso. DELETE en un URI de recurso.
parche Actualizar un recurso con la semántica de parches PATCH en un URI de recurso.
actualizar Actualiza un recurso. PUT en un URI de recurso.

En la siguiente tabla, se muestran los métodos compatibles con cada tipo de recurso. Todas las operaciones list y get en blogs privados requieren autenticación.

Tipo de recurso
Métodos admitidos
lista obtener getByUrl getByPath. listByUser. búsqueda insertar borrar Parche actualización
Blogs no no no no no no no
Publicaciones no no
Comentarios no no no no no no no no
Páginas no no no no no no no no
Usuarios no no no no no no no no no

Estilos de llamada

Hay varias formas de invocar la API:

REST

REST es un estilo de arquitectura de software que proporciona un enfoque conveniente y coherente para solicitar y modificar datos.

El término REST es el acrónimo en inglés de "Transferencia de estado representacional". En el contexto de las API de Google, se refiere al uso de verbos HTTP para recuperar y modificar representaciones de los datos que almacena Google.

En un sistema RESTful, los recursos se almacenan en un almacén de datos; un cliente envía una solicitud para que el servidor ejecute una acción en particular (como crear, recuperar, actualizar o borrar un recurso) y el servidor ejecuta la acción y envía una respuesta que, por lo general, es una representación del recurso especificado.

En las API de RESTful de Google, el cliente especifica una acción con un verbo HTTP como POST, GET, PUT o DELETE. Especifica un recurso mediante un URI único a nivel global de la siguiente forma:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Dado que todos los recursos de API tienen URI únicos accesibles a través de HTTP, REST permite el almacenamiento de datos en caché y está optimizado para funcionar con la infraestructura distribuida de la Web.

Puedes encontrar las definiciones de métodos en la documentación de estándares del HTTP 1.1, los que incluyen especificaciones para GET, POST, PUT y DELETE.

REST en la API de Blogger

Las operaciones de Blogger admitidas se asignan directamente a los verbos HTTP de REST, como se describe en las operaciones de la API de Blogger.

El formato específico para los URI de la API de Blogger es:

https://www.googleapis.com/blogger/v3/users/userId
https://www.googleapis.com/blogger/v3/users/self
https://www.googleapis.com/blogger/v3/users/userId/blogs
https://www.googleapis.com/blogger/v3/users/self/blogs
https://www.googleapis.com/blogger/v3/blogs/blogId
https://www.googleapis.com/blogger/v3/blogs/byurl
https://www.googleapis.com/blogger/v3/blogs/blogId/posts
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/bypath
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/search
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments/commentId
https://www.googleapis.com/blogger/v3/blogs/blogId/pages
https://www.googleapis.com/blogger/v3/blogs/blogId/pages/pageId

La explicación completa de los URI usados y los resultados de cada operación compatible en la API se resumen en el documento Referencia de la API de Blogger.

Ejemplos

Enumera los blogs para los que el usuario autenticado tiene derechos de acceso:

GET https://www.googleapis.com/blogger/v3/users/self/blogs?key=YOUR-API-KEY

Obtén las entradas en el blog code.blogger.com, que tiene el ID de blog 3213900:

GET https://www.googleapis.com/blogger/v3/blogs/3213900?key=YOUR-API-KEY

REST de JavaScript

Puedes invocar la API de Blogger desde JavaScript mediante el parámetro de búsqueda callback y proporcionando una función de devolución de llamada. Cuando el navegador carga la secuencia de comandos, se ejecuta la función de devolución de llamada y se proporciona la respuesta a esta función. Este enfoque te permite escribir aplicaciones enriquecidas que muestran datos de Blogger sin requerir código del servidor.

En el siguiente ejemplo, se recupera una entrada del blog code.blogger.com después de reemplazar YOUR-API-KEY por tu clave de API.

<html>
  <head>
    <title>Blogger API Example</title>
  </head>
  <body>
    <div id="content"></div>
    <script>
      function handleResponse(response) {
        document.getElementById("content").innerHTML += "<h1>" + response.title + "</h1>" + response.content;
      }
    </script>
    <script
    src="https://www.googleapis.com/blogger/v3/blogs/3213900/posts/8398240586497962757?callback=handleResponse&key=YOUR-API-KEY"></script>
  </body>
</html>

Formato de los datos

JSON

JSON (JavaScript Object Notation) es un formato de datos común y, también, independiente del lenguaje que proporciona una representación de texto simple de estructuras de datos arbitrarias. Para obtener más información, visita json.org.