API Blogger: premiers pas

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Ce document explique comment utiliser l'API Blogger.

Avant de commencer

Obtenir un compte Google

Assurez-vous de disposer d'un compte Google. Nous vous recommandons d'utiliser un compte Google distinct à des fins de développement et de test pour vous protéger contre toute perte accidentelle de données. Si vous disposez déjà d'un compte de test, vous êtes prêt. Vous pouvez visiter l'interface utilisateur de Blogger pour configurer, modifier ou afficher vos données de test.

Familiarisez-vous 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 bien Blogger, 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, elle 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 savoir comment autoriser des requêtes et utiliser des clés API, consultez la page Autoriser des requêtes et identifier votre application dans le document "Utiliser l'API".

Arrière-plan de l'API Blogger

Concepts de 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 du blog, telles que son nom et sa description.
  • Articles: un article de blog est l'élément publiable créé par l'auteur du blog. Cette information est destinée à refléter la périodicité actuelle des auteurs au monde. Il est évident qu'avec le temps, le contenu des articles de blog vieillit et devient moins important.
  • Commentaires : un commentaire est un lieu où les personnes (autres que l'auteur de l'article de blog) réagissent à ce que l'auteur a écrit. Des briques aux bouquets,
  • Pages: une page est un emplacement pour un contenu statique tel que des informations biographiques ou des moyens de contacter l'utilisateur. Ces informations sont généralement intemporelles et ne changent pas très souvent.
  • Utilisateurs: un utilisateur est une personne qui interagit avec Blogger en tant qu'auteur, administrateur ou lecteur. Pour les blogs publics, les lecteurs peuvent être anonymes, mais sur les blogs privés, un lecteur doit être identifié par Blogger.

Modèle de données de l'API Blogger

Une ressource est une entité de données individuelle dotée 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 une publication. Chaque ressource Articles est une ressource enfant d'une ressource de blogs.
  • Ressource de commentaires : représente un commentaire sur un post spécifique. Chaque ressource de commentaire est un enfant d'une ressource de post.
  • Ressource Pages: représente une page statique. Chaque ressource Pages est un enfant d'une ressource Blogs.
  • Ressource Users: représente un utilisateur non anonyme. Ce champ permet d'identifier l'auteur d'une page, d'un post ou d'un commentaire.
La ressource des blogs comporte deux types de ressources enfants : des pages et des articles.
          Une ressource "posts" peut contenir des ressources enfants de commentaires.
Présentation des relations entre les ressources

Le modèle de données de l'API Blogger est basé sur des groupes de ressources, appelés collections:

Collection de blogs
Une collection <span=\"quot;apicollection">blogs est constituée de tous les blogs auxquels un utilisateur a accès. Vous pouvez répertorier les blogs par utilisateur ou récupérer un seul blog par ID.</span=\"quot;apicollection">
Collecte des posts
Une collection d'articles contient toutes les ressources des articles d'une ressource de blogs.
Collecte des commentaires
Une collection de commentaires contient toutes les ressources sur les commentaires au sein d'une ressource de posts spécifique.
Collection de pages
Une collection de pages contient toutes les ressources de pages d'une ressource de blog spécifique.
Collection d'utilisateurs
Une collection d'utilisateurs est constituée de toutes les ressources utilisateur sur Blogger et ne peut donc pas être répertoriée. Un utilisateur peut récupérer sa propre ressource utilisateur (mais personne d'autre) à l'aide de son ID ou de l'identifiant self.

Opérations de l'API Blogger

Vous pouvez appeler différentes méthodes sur les collections et les ressources dans l'API Blogger, comme décrit dans le tableau suivant.

Operations Description Mappages HTTP REST
list Répertorie toutes les ressources d'une collection. GET sur un URI de collection.
obtenir Récupère une ressource spécifique. GET sur un URI de ressource.
getByUrl. Récupère une ressource qui la recherche par URL. GET avec l'URL transmise en tant que paramètre.
getByPath. Récupère une ressource en la recherchant selon son chemin d'accès. GET par le chemin transmis en tant que paramètre.
listByUser. Répertorie les ressources appartenant à un utilisateur. GET sur une collection appartenant à l'utilisateur
search Recherchez des ressources en fonction d'un paramètre de requête. GET sur une URL de recherche, avec la requête transmise en tant que paramètre.
Insérer Créez une ressource dans une collection. POST sur un URI de collection.
supprimer Supprime une ressource. DELETE sur un URI de ressource.
correctif Mettre à jour une ressource à l'aide de la sémantique "patch" PATCH sur un URI de ressource.
mettre à jour Mettre à jour une ressource PUT 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 getByUrl. getByPath. listByUser. rechercher insérer supprimer correctif mettre à jour
Blogs non oui oui non oui Non non non non non
Posts oui oui non oui non oui oui oui oui oui
Commentaires oui oui Non non non non non non non non
Pages oui oui Non non non non non non non non
Utilisateurs non oui Non non non non non non non non

Styles d'appel

Il existe plusieurs façons d'appeler l'API:

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 comme POST, GET, PUT ou DELETE. Il spécifie une ressource par un URI 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 Blogger

Les opérations Blogger compatibles sont mappées directement à des verbes HTTP REST, comme décrit dans la section Opérations de l'API Blogger.

Le format spécifique des URI de l'API Blogger est le suivant:

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

Vous trouverez une explication complète des URI utilisés et des résultats de chaque opération disponible dans l'API dans la documentation de référence de l'API Blogger.

Exemples

Répertoriez les blogs auxquels l'utilisateur authentifié a accès:

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

Téléchargez les articles sur le blog code.blogger.com, dont l'ID de blog est 3213900:

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

REST à partir de JavaScript

Vous pouvez appeler l'API Blogger à partir de JavaScript à l'aide du paramètre de requête callback et en fournissant une fonction de rappel. Lorsque le navigateur charge le script, la fonction de rappel est exécutée, et la réponse est transmise à la fonction de rappel. Cette approche vous permet de développer des applications enrichies qui affichent les données Blogger sans avoir à é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 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>

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.