Importante: Daremos de baja la compatibilidad con la API de JSON v2.0 el 30 de septiembre de 2024. Para garantizar la continuidad del funcionamiento, actualiza las aplicaciones que usan 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 explica cómo comenzar a usar la API de JSON de Blogger.
Contenido
Introducción
Este documento está dirigido a desarrolladores que deseen escribir aplicaciones que puedan interactuar con la API de JSON de Blogger.
La API de JSON de Blogger extiende la versión 2.0 de la API de datos de Blogger. Si deseas recuperar datos de Blogger en formato JSON en lugar de XML, usa la API de JSON de Blogger. Si deseas recuperar datos en formato XML, usa la API de Blogger Data.
Actualmente, esta versión de la API de JSON de Blogger es de solo lectura. Sin embargo, planeamos agregar capacidades de lectura y escritura, así como otras funciones. No dudes en solicitar otras funciones en el Foro de ayuda 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 independiente para fines de desarrollo y pruebas para 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 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 codificar. En este documento, se da por sentado que conoces Blogger, los conceptos de programación web y los formatos de datos web.
Más información para autorizar solicitudes y para 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.
Si 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 Cómo autorizar solicitudes y identificar tu aplicación en el documento Cómo usar la API.
Información general de la API de JSON de Blogger
Conceptos de Blogger
Blogger se basa en cinco conceptos básicos:
- Blogs: Es 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.
- Publicaciones: Una entrada de blog es el elemento publicable que creó el autor del blog. Esta información debe ser oportuna y reflejar lo que los autores quieren publicar en el mundo ahora. Se entiende que, a medida que pasa el tiempo, el contenido de las entradas de blog envejece y se vuelve menos relevante.
- Comentarios: Los comentarios son el lugar donde personas que no son el autor de la entrada del blog reaccionan a lo que escribió. Todo, desde ladrillos hasta bouquets.
- 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 una persona que interactúa con Blogger, ya sea como autor, administrador o solo lector. En el caso de los blogs públicos, los lectores pueden ser anónimos, pero en los blogs privados, Blogger debe identificar a los lectores.
Modelo de datos de la API de JSON 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 publicaciones: Representa una publicación. Cada recurso de publicaciones 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 Users: Representa a 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 JSON de Blogger se basa en grupos de recursos, llamados colecciones:
- Colección de blogs
- Una <span="apicollection">colección de blogs consiste en todos los blogs a los que un usuario tiene derechos de acceso. Puedes enumerar los blogs por usuario o recuperar un blog individual por ID.</span="apicollection">
- Colección de publicaciones
- Una colección de publicaciones consta de todos los recursos de publicaciones dentro de un recurso de blogs específico.
- Colección de 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 páginas dentro de un recurso de blogs específico.
- Colección de usuarios
- Una colección de usuarios consta de todos los recursos de usuarios en Blogger y, por lo tanto, no se puede enumerar. Un usuario puede recuperar su propio recurso de usuarios (pero no el de nadie más) por ID o con el identificador
self.
Operaciones de la API de JSON de Blogger
Puedes invocar dos métodos diferentes en las colecciones y los recursos de la API de JSON 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. |
En la siguiente tabla, se muestran los métodos que admite cada tipo de recurso. Todas las operaciones de lista y obtener en blogs privados requieren autenticación.
Tipo de recurso |
Métodos admitidos |
|
|---|---|---|
| list | get | |
| Blogs | sí | sí |
| Publicaciones | sí | sí |
| Comentarios | sí | sí |
| Páginas | sí | sí |
| Usuarios | no | sí |
Estilos de llamada
Existen varias formas de invocar la API:
- Con REST directamente o desde JavaScript (no se requiere código del servidor)
- Con 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 la abreviatura de "Representational State Transfer" (transferencia de estado representacional). En el contexto de las API de Google, se refiere al uso de los verbos HTTP para recuperar y modificar las representaciones de los datos almacenados por 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 con tecnología REST 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 manera:
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 JSON 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 JSON de Blogger.
Los formatos específicos para los URI de la API de JSON de Blogger son los siguientes:
https://www.googleapis.com/blogger/v2/users/userId https://www.googleapis.com/blogger/v2/users/self https://www.googleapis.com/blogger/v2/users/userId/blogs https://www.googleapis.com/blogger/v2/users/self/blogs https://www.googleapis.com/blogger/v2/blogs/blogId/posts https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId https://www.googleapis.com/blogger/v2/blogs/blogId/pages https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId
La explicación completa de los URIs utilizados y los resultados de cada operación compatible en la API se resume en el documento Referencia de la API de JSON de Blogger.
Estos son algunos ejemplos de cómo funciona esto en la API de JSON de Blogger.
Enumera los blogs a los que el usuario autenticado tiene derechos de acceso:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
Obtén las publicaciones del blog code.blogger.com (que tiene el ID de blog 3213900):
GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY
REST desde JavaScript
Puedes invocar la API de JSON de Blogger con REST desde JavaScript usando el parámetro de consulta callback y una función de devolución de llamada. Esto te permite escribir aplicaciones enriquecidas que muestren datos de Blogger sin escribir ningún código del servidor.
En el siguiente ejemplo, se recupera una publicación del blog code.blogger.com (después de reemplazar YOUR-API-KEY por tu clave de API).
<html>
<head>
<title>Blogger JSON 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/v2/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.