Important : La version 2.0 de l'API JSON ne sera plus compatible à partir du 30 septembre 2024. Pour assurer un fonctionnement continu, mettez à jour vos applications qui dépendent de la version 2.0 de l'API JSON vers la dernière version. Pour accéder à la version la plus récente, utilisez les liens de la barre de navigation de gauche.
Ce document explique comment utiliser l'API JSON Blogger.
Sommaire
Introduction
Ce document est destiné aux développeurs qui souhaitent écrire des applications pouvant interagir avec l'API JSON Blogger.
L'API JSON Blogger étend la version 2.0 de l'API Blogger Data. Pour récupérer des données dans Blogger au format JSON plutôt qu'au format XML, utilisez l'API JSON Blogger. Si vous souhaitez récupérer des données au format XML, utilisez l'API Blogger Data.
Cette version de l'API JSON Blogger est actuellement en lecture seule. Toutefois, nous prévoyons d'ajouter des fonctionnalités de lecture/écriture, ainsi que d'autres fonctionnalités. N'hésitez pas à demander d'autres fonctionnalités sur le forum d'aide de Blogger.
Avant de commencer
Obtenir un compte Google
Assurez-vous de configurer un compte Google. Nous vous recommandons d'utiliser un compte Google distinct à des fins de développement et de test, afin de vous protéger contre la perte accidentelle de données. Si vous possédez déjà un compte test, vous êtes prêt et vous pouvez visiter l'interface utilisateur de Blogger pour configurer, modifier ou afficher vos données de test.
Se familiariser avec Blogger
Si vous ne connaissez pas les concepts de Blogger, lisez ce document et testez l'interface utilisateur avant de commencer à coder. Dans ce document, nous partons du principe que vous connaissez Blogger, ainsi que les concepts de programmation Web et les formats de données Web.
En savoir plus sur l'autorisation des requêtes et l'identification de votre application
Lorsque votre application demande des données privées, cette requête doit être autorisée par un utilisateur authentifié qui a accès à ces données.
Lorsque votre application demande des données publiques, la requête n'a pas besoin d'être autorisée, mais elle doit être accompagnée d'un identifiant, tel qu'une clé API.
Pour en savoir plus sur l'autorisation des requêtes et l'utilisation des clés API, consultez la section Autoriser les requêtes et identifier votre application dans le document "Utiliser l'API".
Arrière-plan de l'API JSON Blogger
Concepts Blogger
Blogger repose sur cinq concepts de base:
- Blogs: concept racine de l'API. Un blog contient des articles et des pages. Il s'agit du conteneur des méta-informations de blog telles que le nom et la description du blog.
- Articles: un article de blog est l'élément publiable créé par l'auteur du blog. Ces informations sont censées être actualisées et refléter ce que les auteurs veulent publier dès maintenant. Il est entendu qu'au fil du temps, le contenu des articles de blog vieillit et devient moins pertinent.
- Commentaires: un commentaire est l'endroit où des personnes autres que l'auteur de l'article de blog réagissent à ce qu'il a écrit. Il y a tout, des briques aux bouquets.
- Pages: une page est un emplacement pour du contenu statique, comme des informations biographiques ou les moyens de contacter l'utilisateur. Il s'agit généralement d'informations intemporelles qui ne changent pas très souvent.
- Utilisateurs: un utilisateur est une personne qui interagit avec Blogger, qu'il agisse en tant qu'auteur, administrateur ou simplement lecteur. Pour les blogs publics, les lecteurs peuvent être anonymes, mais sur les blogs privés, ils doivent être identifiés par Blogger.
Modèle de données de l'API JSON Blogger
Une ressource est une entité de données individuelle disposant d'un identifiant unique. L'API JSON de Blogger fonctionne sur cinq types de ressources:
- Ressource Blogs: représente un blog.
- Ressource Posts: représente un article. Chaque ressource "Posts" est un enfant d'une ressource "Blogs".
- Ressource Comments: représente un commentaire sur un article spécifique. Chaque ressource "Comments" est un enfant d'une ressource "Posts".
- Ressource Pages: représente une page statique. Chaque ressource Pages est un enfant d'une ressource Blogs.
- Ressource "Utilisateurs": représente un utilisateur non anonyme. Ce nom permet d'identifier l'auteur d'une page, d'un post ou d'un commentaire.
Le modèle de données de l'API JSON Blogger est basé sur des groupes de ressources, appelés collections:
- Collection de blogs
- Une <span="apicollection">collection de blogs comprend tous les blogs auxquels un utilisateur dispose de droits d'accès. Vous pouvez répertorier les blogs par utilisateur ou récupérer un seul blog par ID.</span="apicollection">
- Collection de posts
- Une collection de posts comprend toutes les ressources "Posts" dans une ressource "Blogs" spécifique.
- Collection de commentaires
- Une collection de commentaires comprend toutes les ressources "Commentaires" au sein d'une ressource "Posts" spécifique.
- Collection "Pages"
- Une collection Pages comprend toutes les ressources Pages au sein d'une ressource Blogs spécifique.
- Collection "Utilisateurs"
- Une collection Utilisateurs comprend toutes les ressources Utilisateurs sur Blogger. Elle ne peut donc pas être répertoriée. Un utilisateur peut récupérer sa propre ressource "Users" (mais celle de personne d'autre) à l'aide de son ID ou de l'identifiant
self.
Opérations de l'API JSON Blogger
Vous pouvez appeler deux méthodes différentes sur les collections et les ressources dans l'API JSON Blogger, comme décrit dans le tableau suivant.
| Opération | Description | Mappages HTTP REST |
|---|---|---|
| liste | Répertorie toutes les ressources d'une collection. | GET sur un URI de collection. |
| get | Récupère une ressource spécifique. | GET sur un URI de ressource. |
Le tableau ci-dessous indique les méthodes compatibles avec chaque type de ressource. Toutes les opérations list et get sur les blogs privés nécessitent une authentification.
Type de ressource |
Méthodes compatibles |
|
|---|---|---|
| liste | get | |
| Blogs | oui | oui |
| Posts | oui | oui |
| Commentaires | oui | oui |
| Pages | oui | oui |
| Utilisateurs | no | oui |
Styles d'appel
Il existe plusieurs façons d'appeler l'API:
- En utilisant REST directement ou à partir de JavaScript (aucun code côté serveur requis)
- À l'aide des bibliothèques clientes
REST
Il s'agit d'un style d'architecture logicielle qui permet de demander et modifier des données de manière pratique et cohérente.
Le terme REST est l'acronyme de Representational State Transfer. Dans le contexte des API Google, il désigne l'utilisation de verbes HTTP pour extraire et modifier des représentations de données stockées par Google.
Dans un système RESTful, les ressources sont stockées dans un datastore. Un client envoie une requête pour que le serveur exécute une action spécifique (par exemple la création, l'extraction, la mise à jour ou la suppression d'une ressource), et le serveur exécute l'action et envoie une réponse, souvent sous la forme d'une représentation de la ressource spécifiée.
Dans les API RESTful de Google, le client spécifie une action à l'aide d'un verbe HTTP tel que POST, GET, PUT ou DELETE. Il spécifie une ressource avec un URI global unique au format suivant:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Étant donné que toutes les ressources d'API possèdent des URI uniques accessibles via HTTP, REST permet la mise en cache des données, et son fonctionnement est optimisé pour l'infrastructure distribuée du Web.
Les définitions de méthode figurant dans la documentation du standard HTTP 1.1 peuvent s'avérer utiles, car elles incluent les spécifications pour GET, POST, PUT, et DELETE.
REST dans l'API JSON Blogger
Les opérations Blogger compatibles sont directement mappées aux verbes HTTP REST, comme décrit dans la section Opérations de l'API JSON Blogger.
Le format spécifique pour les URI de l'API JSON Blogger est le suivant:
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
Vous trouverez une explication complète des URI utilisés et les résultats de chaque opération disponible dans l'API dans la documentation de référence de l'API JSON de Blogger.
Voici quelques exemples de ce fonctionnement dans l'API JSON Blogger.
Répertoriez les blogs auxquels l'utilisateur authentifié dispose de droits d'accès:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
Téléchargez les articles sur le blog code.blogger.com (ID de blog : 3213900) :
GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY
REST à partir de JavaScript
Vous pouvez appeler l'API JSON Blogger en utilisant REST à partir de JavaScript, en utilisant le paramètre de requête callback et une fonction de rappel. Cela vous permet de développer des applications enrichies qui affichent des données Blogger sans écrire de code côté serveur.
L'exemple suivant récupère un article du blog code.blogger.com (après avoir remplacé YOUR-API-KEY par votre clé 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>
Format des données
JSON
JSON (JavaScript Object Notation) est un format de données qui ne dépend pas d'un langage et qui fournit une représentation textuelle simple de structures de données arbitraires. Pour en savoir plus, accédez à json.org.