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 explica cómo comenzar a utilizar la API de Blogger JSON.
Contenido
Introducción
Este documento está dirigido a desarrolladores que deseen escribir aplicaciones que puedan interactuar con la API de Blogger JSON.
La API de JSON de Blogger extiende la versión 2.0 de la API de datos de Blogger. Si quieres recuperar datos de Blogger en formato JSON en lugar de XML, usa la API de JSON de Blogger. Si quieres recuperar datos en formato XML, usa la API de datos de Blogger.
Actualmente, esta versión de la API de JSON de Blogger es de solo lectura. Sin embargo, planeamos agregar capacidades de lectura y escritura, además de otras. 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 una Cuenta de Google configurada. Te recomendamos que uses una Cuenta de Google separada con fines de desarrollo y prueba, para protegerte de la pérdida accidental de datos. Si ya tienes una cuenta de prueba, no necesitas 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 programar. En este documento, se asume que estás familiarizado con Blogger, los conceptos de programación web y los formatos de datos web.
Más información para identificar tu aplicación y autorizar solicitudes
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 Autoriza solicitudes e identifica tu aplicación en el documento Cómo usar la API.
Fondo de la API de Blogger JSON
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. Es el contenedor de la metainformación del blog, como el nombre y la descripción del blog.
- Entradas: Una entrada de blog es un elemento publicable que creó el autor del blog. El propósito de esta información es que sea oportuno y que refleje lo que los autores desean publicar para el mundo ahora. Se entiende que, con el paso del tiempo, el contenido de las entradas de blog envejece y se vuelve menos relevante.
- Comentarios: Un comentario es el lugar en el que otras personas, además del autor de la entrada de blog, reaccionan a lo que escribió. Todo, desde ladrillos hasta ramos de flores.
- Páginas: Una página es un lugar para acceder a 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 muy a menudo.
- Usuarios: Un usuario es alguien que interactúa con Blogger, ya sea como autor, administrador o simplemente como lector. En el caso de los blogs públicos, los lectores pueden ser anónimos, pero Blogger debe identificar a los lectores en los blogs privados.
Modelo de datos de la API de Blogger JSON
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 de una publicación específica. Cada recurso de comentarios es un elemento secundario de un recurso de publicaciones.
- Pages Resource: Representa una página estática. Cada recurso de Pages es un elemento secundario de un recurso de Blogs.
- Recurso de usuarios: Representa a un usuario no anónimo. Se usa para identificar el autor de una página, entrada o 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 consta de todos los blogs a los que un usuario tiene derechos de acceso. Puedes enumerar los blogs por usuario o recuperar uno solo por ID.</span="apicollection">
- Colección de publicaciones
- Una colección de entradas consta de todos los recursos para las entradas 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 las páginas dentro de un recurso de blogs específico.
- Colección de usuarios
- Una colección de usuarios consta de todos los recursos para usuarios en Blogger y, por lo tanto, no puede enumerarse. Un usuario puede recuperar su propio recurso de usuarios (pero el de nadie más) por ID o mediante el identificador
self.
Operaciones de la API de Blogger JSON
Puedes invocar dos métodos diferentes en colecciones y recursos en la API de Blogger JSON, como se describe en la siguiente tabla.
| Operación | Descripción | Asignaciones de HTTP de REST |
|---|---|---|
| list | Enumera todos los recursos dentro 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 list y get en blogs privados requieren autenticación.
Tipo de recurso |
Métodos admitidos |
|
|---|---|---|
| lista | obtener | |
| 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:
- A través de REST directamente o desde JavaScript (no se requiere 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 JSON de Blogger
Las operaciones de Blogger admitidas se asignan directamente a los verbos HTTP REST, como se describe en las operaciones de la API de Blogger JSON.
El formato específico para los URI de la API de Blogger JSON es el siguiente:
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 para cada operación compatible en la API se resume en el documento de referencia de la API de Blogger JSON.
A continuación, se muestran 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 entradas en el 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 de JavaScript
Puedes invocar la API de JSON de Blogger con REST desde JavaScript mediante 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 entrada 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.