Cette page a été traduite par l'API Cloud Translation.

API Blogger: premiers pas

Ce document explique comment commencer à utiliser l'API Blogger.

Avant de commencer

Obtenir un compte Google

Assurez-vous d'avoir configuré un compte Google. Nous vous recommandons d'utiliser un compte Google distinct à des fins de développement et de test. Vous éviterez ainsi 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.

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, 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, la 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 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 Blogger

Concepts Blogger

Blogger repose sur cinq concepts fondamentaux:

Blogs: concept racine de l'API. Un blog contient des articles et des pages. Il s'agit du conteneur des méta-informations sur le blog, telles que son nom et sa description.
Articles: un article de blog est l'élément publiable créé par l'auteur du blog. Ces informations sont destinées à être d'actualité et refléter ce que les auteurs souhaitent publier sur le Web aujourd'hui. Il est entendu qu'au fil du temps, les articles de blog vieillissent et deviennent moins pertinents.
Commentaires: des personnes autres que l'auteur de l'article de blog réagissent à son commentaire. Des briques aux bouquets.
Pages: une page est un emplacement pour du contenu statique, comme des informations biographiques ou les moyens de contacter les utilisateurs. Il s'agit généralement d'informations intemporelles qui ne changent pas très souvent.
Utilisateurs: personne qui interagit avec Blogger, qu'il s'agisse d'un auteur, d'un administrateur ou simplement d'un lecteur. Pour les blogs publics, les lecteurs peuvent être anonymes. En revanche, pour les blogs privés, ils doivent être identifiés par Blogger.

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

Une ressource est une entité de données individuelle disposant d'un identifiant unique. L'API JSON Blogger fonctionne sur cinq types de ressources:

Ressource Blogs: représente un blog.
Ressource "Posts": représente un article. Chaque ressource "Articles" est l'enfant d'une ressource de blog.
Ressource Commentaires: représente un commentaire sur un article spécifique. Chaque ressource de commentaires est un enfant d'une ressource de post.
Ressource Pages: représente une page statique. Chaque ressource de page est un enfant d'une ressource de blog.
Ressource Users: représente un utilisateur non anonyme. Cette information permet d'identifier l'auteur d'une page, d'un post ou d'un commentaire.

La ressource de blogs a deux types de ressources enfants, les pages et les messages.
Une ressource de posts peut avoir des enfants de ressources 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 <span="apicollection">collection de blogs comprend tous les blogs auxquels un utilisateur a des droits d'accès. Vous pouvez répertorier les blogs par utilisateur ou récupérer un blog par ID.</span="apicollection">
Collection "Posts": Une collection "Posts" comprend toutes les ressources "Posts" dans une ressource de blog spécifique.
Collection de commentaires: Une collection de commentaires comprend toutes les ressources Commentaires dans une ressource Posts spécifique.
Collection de pages: Une collection de pages comprend toutes les ressources de page d'une ressource de blog spécifique.
Collection "Utilisateurs": Une collection d'utilisateurs comprend toutes les ressources "users" sur Blogger et ne peut donc pas être répertoriée. Un utilisateur peut récupérer sa propre ressource d'utilisateur (mais celle de personne d'autre) par ID ou à l'aide 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.

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
getByUrl	Récupère une ressource en la recherchant par URL.	`GET` par l'URL transmise en tant que paramètre.
getByPath	Récupère une ressource en la recherchant par son chemin d'accès.	`GET` par le chemin d'accès 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
patch	Mettre à jour une ressource à l'aide de la sémantique Patch.	`PATCH` sur un URI de ressource
mise à 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 des blogs privés nécessitent une authentification.

Type de ressource	Méthodes compatibles
	liste	get	getByUrl	getByPath	listByUser	recherche	insérer	supprimer	correctif	mise à 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:

En utilisant REST directement ou à partir de JavaScript (aucun code côté serveur requis)
Utiliser les 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 par un URI globalement 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 prises en charge sont directement mappées aux 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

L'explication complète des URI utilisés et les résultats de chaque opération compatible avec l'API est résumée dans la documentation de référence de l'API Blogger.

Exemples

Répertoriez les blogs auxquels l'utilisateur authentifié dispose de droits d'accès:

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

Récupérez 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 en utilisant le 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 des données Blogger sans nécessiter 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.