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 utilices una Cuenta de Google independiente para el desarrollo y las pruebas a fin de protegerte de la pérdida accidental de datos. Si ya tienes una cuenta de prueba, está todo listo. Puedes visitar la interfaz de usuario de Blogger para configurar, editar o ver tus datos de prueba.
Familiarízate con Blogger
Si no conoces los conceptos de Blogger, lee este documento y experimenta con la interfaz de usuario antes de comenzar a programar. En este documento, se asume que estás familiarizado con Blogger, con conceptos de programación web y con formatos de datos web.
Más información sobre la autorización de solicitudes y la identificación de 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 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 Cómo autorizar solicitudes y cómo identificar tu aplicación en el documento Cómo usar la API.
Información sobre la API de Blogger
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 publicable que creó el autor del blog. El objetivo de esta información es que sea oportuna, que refleje lo que los autores quieren publicar para el mundo en la actualidad. Se entiende que, a medida que pasa el tiempo, el contenido de las entradas de blog se vuelve menos relevante.
- Comentarios: Un comentario es el lugar donde las personas que no son el autor de la entrada de blog reaccionan a lo que escribió. de todo, desde ladrillos a 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, es información atemporal que no cambia con mucha frecuencia.
- Usuarios: Un usuario es alguien que interactúa con Blogger, ya sea como autor, administrador o simplemente lector. En el caso de los blogs públicos, los lectores pueden ser anónimos, pero en los blogs privados, Blogger debe identificarlos.
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 funciona con 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áginas es un elemento secundario de un recurso de blogs.
- Recurso de usuarios: Representa un usuario no anónimo. Se usa para identificar al autor de una página, una publicación o un comentario.
El modelo de datos de la API de Blogger se basa en grupos de recursos llamados colecciones:
- Colección de blogs
- Una <span="apicollection">colección de blogs consta de todos los blogs a los que un usuario tiene derechos de acceso. Puedes enumerar los blogs según el usuario o recuperar un solo blog por ID.</span="apicollection">
- Colección de publicaciones
- Una colección de entradas consta de todos los recursos de publicaciones dentro de un recurso de blogs específico.
- Colección Comentarios
- Una colección de comentarios consta de 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 las páginas dentro de un recurso de blog específico.
- Colección de usuarios
- Una colección de usuarios consta de todos los recursos de usuarios de Blogger y, por lo tanto, no se puede enumerar. Un usuario puede recuperar su propio recurso de usuario (pero el de nadie más) mediante el ID o mediante el identificador
self.
Operaciones de la API de Blogger
Puedes invocar varios métodos diferentes en las colecciones y los recursos en la API de Blogger, como se describe en la siguiente tabla.
| Operación | Descripción | Asignaciones de HTTP de REST |
|---|---|---|
| list | Muestra una lista de todos los recursos de una colección. | GET en un URI de colección |
| get | Obtiene un recurso específico. | GET en un URI de recurso |
| getByUrl | Obtiene un recurso mediante la búsqueda por URL. | GET por la URL que se pasa como parámetro |
| getByPath | Para obtener un recurso, busca por su ruta de acceso. | GET por la ruta que se pasa como parámetro. |
| listByUser | Enumera los recursos que son propiedad de un usuario. | GET en una colección del usuario. |
| search | Busca recursos en función de un parámetro de consulta. | GET en una URL de búsqueda, con la búsqueda 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 |
| patch | Actualizar un recurso con la semántica de parches | PATCH en un URI de recurso |
| actualización | 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 compatibles |
|||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| lista | obtener | getByUrl | getByPath | listByUser | buscar | insertar | borrar | parche | actualización | |
| Blogs | no | sí | sí | no | sí | no | no | no | no | no |
| Publicaciones | sí | sí | no | sí | no | sí | sí | sí | sí | sí |
| Comentarios | sí | sí | no | no | no | no | no | no | no | no |
| Páginas | sí | sí | no | no | no | no | no | no | no | no |
| Usuarios | no | sí | no | no | no | no | no | no | no | no |
Estilos de llamada
Hay varias formas de invocar la API:
- Uso de REST directamente o desde JavaScript (no se necesita un código del servidor)
- Usar las bibliotecas cliente
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 APIs 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 con 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 Operaciones de la API de Blogger.
El formato específico para los URI de la API de Blogger es el siguiente:
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 resume en el documento Referencia de la API de Blogger.
Ejemplos
Enumera los blogs en 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 desde JavaScript
Puedes invocar la API de Blogger desde JavaScript, usando 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 la respuesta se proporciona 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.