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

API JSON Blogger: Utilisation de l'API

Important : Nous cesserons de prendre en charge l'API JSON v2.0 le 30 septembre 2024. Pour vous assurer que vos applications qui dépendent de l'API JSON 2.0 continuent de fonctionner, mettez-les à jour vers la dernière version de l'API. Pour obtenir la dernière version, utilisez les liens de la barre de navigation de gauche.

Ce document explique comment utiliser les fonctionnalités courantes de l'API JSON Blogger à l'aide du style d'appel RESTful.

Sommaire

Présentation
1. Autoriser les requêtes et identifier votre application
Travailler avec les blogs
1. Récupération d'un blog
2. Récupérer les blogs d'un utilisateur
Utiliser les posts
1. Récupérer les posts d'un blog
2. Récupérer un post spécifique
Utiliser les commentaires
1. Récupérer les commentaires d'un post
2. Récupérer un commentaire spécifique
Utiliser Pages
1. Récupérer les pages d'un blog
2. Récupérer une page spécifique
Travailler avec les utilisateurs
1. Récupérer un utilisateur
Paramètres de requête standards

Introduction

Ce document est destiné aux développeurs qui souhaitent écrire des applications pouvant interagir avec l'API JSON Blogger. Blogger est un outil permettant de créer des sites Web qui permettent aux utilisateurs de publier leurs réflexions en continu.

Si vous ne connaissez pas les concepts de Blogger, consultez la section Premiers pas avant de commencer à coder.

Autoriser les requêtes et identifier votre application

Chaque requête que votre application envoie à l'API JSON Blogger doit identifier votre application auprès de Google. Pour cela, vous pouvez procéder de deux manières: à l'aide d'un jeton OAuth 2.0 (qui autorise également la requête) et/ou à l'aide de la clé API de l'application. Voici comment déterminer l'option à utiliser:

Si la demande nécessite une autorisation (par exemple, s'il s'agit d'une demande de données privées d'un individu), l'application doit fournir un jeton OAuth 2.0 avec la requête. L'application peut également fournir la clé API, mais ce n'est pas obligatoire.
Si la demande ne nécessite pas d'autorisation (par exemple, s'il s'agit d'une demande de données publiques), l'application doit fournir soit la clé API, soit un jeton OAuth 2.0, soit les deux, selon ce qui vous convient le mieux.

À propos des protocoles d'autorisation

Votre application doit autoriser les requêtes via le protocole OAuth 2.0. Les autres protocoles d'autorisation ne sont pas acceptés.

Remarque: L'API JSON Blogger n'est actuellement pas compatible avec la connexion en même temps que la demande d'accès aux données (hybride) ou la délégation d'autorité à l'échelle du domaine (2LO).

Autoriser des requêtes avec OAuth 2.0

Les requêtes adressées à l'API JSON Blogger portant sur des données utilisateur non publiques doivent être autorisées par un utilisateur authentifié.

Les détails de la procédure d'autorisation (ou "flux") pour OAuth 2.0 varient légèrement selon le type d'application que vous développez. La procédure générale suivante s'applique à tous les types d'applications:

Lorsque vous créez votre application, vous l'enregistrez auprès de Google. Google fournit ensuite des informations dont vous aurez besoin ultérieurement, dont un ID et un code secret de client.
Activez l'API JSON Blogger dans le volet "Services" de la console Google APIs. (Si elle n'y est pas répertoriée, ignorez cette étape.)
Lorsque votre application doit accéder à des données utilisateur, elle demande à Google un champ d'application d'accès particulier.
Google affiche alors une boîte de dialogue OAuth qui invite l'utilisateur à autoriser votre application à accéder à certaines de ses données.
Si l'utilisateur accepte, Google attribue à votre application un jeton d'accès temporaire.
Votre application demande des données utilisateur en joignant le jeton d'accès à la requête.
Dès lors que Google valide la requête et le jeton, les données demandées sont renvoyées.

Certains flux comportent d'autres étapes, comme l'utilisation de jetons d'actualisation pour obtenir de nouveaux jetons d'accès. Pour en savoir plus sur les flux pour différents types d'applications, consultez la documentation OAuth 2.0 de Google.

Voici les informations sur le champ d'application OAuth 2.0 pour l'API JSON Blogger:

https://www.googleapis.com/auth/blogger

Pour demander l'accès via OAuth 2.0, votre application a besoin du champ d'application ainsi que des informations fournies par Google lors de son enregistrement (l'ID et/ou le code secret du client, par exemple).

Conseil:Les bibliothèques clientes des API Google peuvent gérer une partie de la procédure d'autorisation à votre place. Elles sont disponibles pour de nombreux langages de programmation. Pour en savoir plus, consultez la page Exemples de code et bibliothèques.

Obtenir et utiliser une clé API

Les requêtes adressées à l'API JSON Blogger pour des données publiques doivent être accompagnées d'un identifiant, qui peut être une clé API ou un jeton d'authentification.

Pour obtenir une clé API, accédez à la console APIs. Dans le volet "Services", activez [api_name]. Si les conditions d'utilisation s'affichent, lisez-les et acceptez-les.

Accédez ensuite au volet Accès aux API. La clé API se trouve en bas de ce volet, dans la section intitulée "Simple API Access" (Accès simple à l'API).

Une fois la clé API obtenue, votre application peut ajouter le paramètre de requête key=yourAPIKey à toutes les URL de requête.

La clé API peut s'intégrer aux URL en toute sécurité et ne nécessite pas d'encodage.

Utilisation des blogs

Récupérer un blog

Vous pouvez récupérer des informations sur une ressource Blogs spécifique en envoyant une requête HTTP GET à l'URI du blog. L'URI d'une ressource Blogs se présente sous le format suivant:

https://www.googleapis.com/blogger/v2/blogs/blogId

Requête

Voici un exemple :

GET https://www.googleapis.com/blogger/v2/blogs/2399953&key=YOUR-API-KEY

Étant donné qu'un utilisateur n'a pas besoin d'être authentifié pour récupérer un blog public, vous n'avez pas besoin de fournir l'en-tête HTTP Authorization avec cette requête GET. Toutefois, si vous ne fournissez pas cet en-tête, vous devez fournir une clé API.

Blogger propose également des blogs privés, qui nécessitent une authentification.

Réponse

Si la requête aboutit, le serveur répond avec un code d'état HTTP 200 OK et les données du blog:

200 OK

{
  "kind": "blogger#blog",
  "id": "2399953",
  "name": "Blogger Buzz",
  "description": "The Official Buzz from Blogger at Google",
  "published": "2007-04-23T22:17:29.261Z",
  "updated": "2011-08-02T06:01:15.941Z",
  "url": "http://buzz.blogger.com/",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953",
  "posts": {
    "totalItems": 494,
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts"
  },
  "pages": {
    "totalItems": 2,
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/pages"
  },
  "locale": {
    "language": "en",
    "country": "",
    "variant": ""
  }
}

Récupérer les blogs d'un utilisateur

Vous pouvez récupérer la liste des blogs d'un utilisateur en envoyant une requête HTTP GET à l'URI de la collection de blogs:

https://www.googleapis.com/blogger/v2/users/userId/blogs

Requête

Voici un exemple de requête GET qui liste les blogs d'un utilisateur:

GET https://www.googleapis.com/blogger/v2/users/self/blogs
Authorization: /* OAuth 2.0 token here */

Remarque: L'utilisateur doit être authentifié pour lister ses propres blogs. Vous devez donc fournir l'en-tête HTTP Authorization avec la requête GET.

Réponse

Si la requête aboutit, le serveur répond avec un code d'état HTTP 200 OK et la représentation complète de la liste des blogs de l'utilisateur:

200 OK

{
  "kind": "blogger#blogList",
  "items": [
    {
      "kind": "blogger#blog",
      "id": "4967929378133675647",
      "name": "Brett's Test Blawg",
      "description": "",
      "published": "2010-10-06T23:33:31.662Z",
      "updated": "2011-08-08T06:50:02.005Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647",
      "posts": {
        "totalItems": 13,
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/posts"
      },
      "pages": {
        "totalItems": 1,
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages"
      },
      "locale": {
        "language": "en",
        "country": "",
        "variant": ""
      }
    }
  ]
}

Utiliser les posts

Récupérer des articles à partir d'un blog

Vous pouvez récupérer une liste de posts d'un blog donné en envoyant une requête GET à l'URI de la collection de posts. L'URI d'une collection de posts se présente comme suit:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts

Requête

Voici un exemple :

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts&key=YOUR-API-KEY

Étant donné qu'un utilisateur n'a pas besoin d'être authentifié pour récupérer les posts d'un blog public, vous n'avez pas besoin de fournir l'en-tête HTTP Authorization avec cette requête GET. Toutefois, si vous ne fournissez pas cet en-tête, vous devez fournir une clé API.

Blogger propose également des blogs privés, qui nécessitent une authentification.

Réponse

Si la requête aboutit, le serveur répond avec un code d'état HTTP 200 OK et la liste des posts:

200 OK

{
  "kind": "blogger#postList",
  "nextPageToken": "CgkIChiAkceVjiYQ0b2SAQ",
  "prevPageToken": "CgkIChDBwrK3mCYQ0b2SAQ",
  "items": [
    {
      "kind": "blogger#post",
      "id": "7706273476706534553",
      "blog": {
        "id": "2399953"
      },
      "published": "2011-08-01T19:58:00.000Z",
      "updated": "2011-08-01T19:58:51.947Z",
      "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553",
      "title": "Latest updates, August 1st",
      "content": "elided for readability",
      "author": {
        "id": "401465483996",
        "displayName": "Brett Wiltshire",
        "url": "http://www.blogger.com/profile/01430672582309320414",
        "image": {
          "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
         }
      },
      "replies": {
        "totalItems": "0",
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments"
      }
    },
    {
      "kind": "blogger#post",
      "id": "6069922188027612413",
      elided for readability
    }
  ]
}

Récupérer un post spécifique

Vous pouvez récupérer un post spécifique d'un blog en envoyant une requête GET à l'URI de la ressource "Posts". L'URI d'une ressource Posts se présente sous la forme suivante:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId

Requête

Voici un exemple :

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553&key=YOUR-API-KEY

Blogger propose également des blogs privés, qui nécessitent une authentification.

Réponse

Si la requête aboutit, le serveur répond avec un code d'état HTTP 200 OK et le contenu du post:

200 OK

{
  "kind": "blogger#post",
  "id": "7706273476706534553",
  "blog": {
    "id": "2399953"
  },
  "published": "2011-08-01T19:58:00.000Z",
  "updated": "2011-08-01T19:58:51.947Z",
  "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553",
  "title": "Latest updates, August 1st",
  "content": "elided for readability",
  "author": {
    "id": "401465483996",
    "displayName": "Brett Wiltshire",
    "url": "http://www.blogger.com/profile/01430672582309320414",
    "image": {
      "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
    }
  },
  "replies": {
    "totalItems": "0",
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments"
  }
}

Utiliser les commentaires

Récupérer les commentaires d'un post

Vous pouvez récupérer une liste de commentaires pour un post en envoyant une requête GET à l'URI de la collection de commentaires. L'URI d'une collection de commentaires se présente comme suit:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments

Requête

Voici un exemple :

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments&key=YOUR-API-KEY

Étant donné qu'un utilisateur n'a pas besoin d'être authentifié pour récupérer les commentaires d'un blog public, vous n'avez pas besoin de fournir l'en-tête HTTP Authorization avec cette requête GET. Toutefois, si vous ne fournissez pas cet en-tête, vous devez fournir une clé API.

Blogger propose également des blogs privés, qui nécessitent une authentification.

Réponse

Si la requête aboutit, le serveur répond avec un code d'état HTTP 200 OK et la liste des commentaires:

200 OK

{
  "kind": "blogger#commentList",
  "nextPageToken": "CgkIFBDwjvDXlyYQ0b2SARj9mZe9n8KsnlQ",
  "prevPageToken": "CgkIFBisvMGRlyYQ0b2SARj9mZe9n8KsnlQ",
  "items": [
    {
       "kind": "blogger#comment",
       "id": "9200761938824362519",
       "post": {
         "id": "6069922188027612413"
       },
       "blog": {
         "id": "2399953"
       },
       "published": "2011-07-28T19:19:57.740Z",
       "updated": "2011-07-28T21:29:42.015Z",
       "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
       "content": "elided",
       "author": {
         "id": "530579030283",
         "displayName": "elided",
         "url": "elided",
         "image": {
           "url": "elided"
         }
       }
    },
    {
      "kind": "blogger#comment",
      "id": "400101178920857170",
      elided for readability
    }
  ]
}

Récupérer un commentaire spécifique

Vous pouvez récupérer un commentaire spécifique à partir d'un post en envoyant une requête GET à l'URI de la ressource "Comments". L'URI d'une ressource "Comments" se présente sous la forme suivante:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId

Requête

Voici un exemple :

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519&key=YOUR-API-KEY

Blogger propose également des blogs privés, qui nécessitent une authentification.

Réponse

Si la requête aboutit, le serveur répond avec un code d'état HTTP 200 OK et les données du commentaire:

200 OK

{
  "kind": "blogger#comment",
  "id": "9200761938824362519",
  "post": {
    "id": "6069922188027612413"
  },
  "blog": {
    "id": "2399953"
  },
  "published": "2011-07-28T19:19:57.740Z",
  "updated": "2011-07-28T21:29:42.015Z",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
  "content": "elided",
  "author": {
    "id": "530579030283",
    "displayName": "elided",
    "url": "elided",
    "image": {
      "url": "elided"
    }
  }
}

Utiliser Pages

Récupérer les pages d'un blog

Vous pouvez récupérer la liste des pages d'un blog en envoyant une requête GET à l'URI de la collection de pages. L'URI d'une collection Pages a le format suivant:

https://www.googleapis.com/blogger/v2/blogs/blogId/pages

Requête

Voici un exemple :

GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages&key=YOUR-API-KEY

Étant donné qu'un utilisateur n'a pas besoin d'être authentifié pour récupérer les pages d'un blog public, vous n'avez pas besoin de fournir l'en-tête HTTP Authorization avec cette requête GET. Toutefois, si vous ne fournissez pas cet en-tête, vous devez fournir une clé API.

Blogger propose également des blogs privés, qui nécessitent une authentification.

Réponse

Si la requête aboutit, le serveur répond avec un code d'état HTTP 200 OK et la liste des pages:

200 OK

{
  "kind": "blogger#pageList",
  "items": [
    {
      "kind": "blogger#page",
      "id": "273541696466681878",
      "blog": {
        "id": "4967929378133675647"
      },
      "published": "2011-07-14T16:16:00.000Z",
      "updated": "2011-07-14T16:16:23.602Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878",
      "title": "Static Content",
      "content": "elided for readability",
      "author": {
        "id": "901569848744",
        "displayName": "brett",
        "url": "http://www.blogger.com/profile/16258312240222542576",
        "image": {
          "url": "https://resources.blogblog.com/img/b16-rounded.gif"
        }
      }
    }
  ]
}

Récupérer une page spécifique

Vous pouvez récupérer une page spécifique d'un blog en envoyant une requête GET à l'URI de la ressource "Pages". L'URI d'une ressource Pages se présente sous le format suivant:

https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId

Requête

Voici un exemple :

GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878&key=YOUR-API-KEY

Blogger propose également des blogs privés, qui nécessitent une authentification.

Réponse

Si la requête aboutit, le serveur répond avec un code d'état HTTP 200 OK et les données de la page:

200 OK

{
  "kind": "blogger#page",
  "id": "273541696466681878",
  "blog": {
    "id": "4967929378133675647"
  },
  "published": "2011-07-14T16:16:00.000Z",
  "updated": "2011-07-14T16:16:23.602Z",
  "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878",
  "title": "Static Content",
  "content": "elided for readability",
  "author": {
    "id": "901569848744",
    "displayName": "brett",
    "url": "http://www.blogger.com/profile/16258312240222542576",
    "image": {
      "url": "https://resources.blogblog.com/img/b16-rounded.gif"
    }
  }
}

Travailler avec les utilisateurs

Récupérer un utilisateur

Vous pouvez récupérer les informations d'un utilisateur en envoyant une requête HTTP GET à l'URI de la ressource "Users" :

https://www.googleapis.com/blogger/v2/users/userId

Requête

Voici un exemple de requête GET qui liste les blogs d'un utilisateur:

GET https://www.googleapis.com/blogger/v2/users/self
Authorization: /* OAuth 2.0 token here */

Remarque: L'utilisateur doit être authentifié pour lister ses propres informations. Vous devez donc fournir l'en-tête HTTP Authorization avec la requête GET.

Réponse

Si la requête aboutit, le serveur répond avec un code d'état HTTP 200 OK et un lien vers la liste des blogs de l'utilisateur:

200 OK

{
  "kind": "blogger#user",
  "id": "901569848744",
  "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744",
  "blogs": {
    "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744/blogs"
  }
}

Paramètres de requête standards

Les paramètres de requête suivants peuvent être utilisés avec toutes les méthodes et toutes les ressources des API Blogger.

Les paramètres de requête qui s'appliquent à toutes les opérations des API Blogger sont répertoriés sur la page Paramètres système.