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

Guide du développeur: PHP

L'API Blogger Data permet aux applications clientes d'afficher et de mettre à jour le contenu Blogger sous la forme de flux de l'API Google Data.

Votre application cliente peut utiliser l'API Blogger Data pour créer des articles de blog, en modifier ou en supprimer des existants, et effectuer des requêtes sur les articles de blog correspondant à des critères particuliers.

En plus de fournir des informations sur les fonctionnalités de l'API Data Blogger, ce document fournit des exemples d'interactions de base avec l'API Data à l'aide de la bibliothèque cliente Zend Google Data. Si vous souhaitez en savoir plus sur le protocole sous-jacent utilisé par la bibliothèque, consultez la section sur le protocole de ce guide du développeur.

Sommaire

Audience
Premiers pas
Authentification auprès du service Blogger
Récupérer une liste de blogs
Créer des posts
1. Publier un article de blog
2. Créer un brouillon de post de blog
Récupération des posts
1. Récupération de tous les articles de blog
2. Récupérer des posts à l'aide de paramètres de requête
Modifier des posts
Supprimer des posts
Commentaires

Audience

Ce document s'adresse aux programmeurs qui souhaitent écrire des applications clientes PHP pouvant interagir avec Blogger.

Ce document part du principe que vous comprenez les idées générales derrière le protocole des API Google Data.

Pour obtenir des informations de référence sur les classes et les méthodes fournies par la bibliothèque cliente, consultez la documentation de référence de l'API de la bibliothèque cliente PHP. Pour en savoir plus sur l'API Blogger Data, consultez le guide de référence du protocole.

Premiers pas

Pour obtenir de l'aide pour configurer la bibliothèque cliente, consultez le guide de démarrage.

La bibliothèque cliente Zend nécessite PHP 5.1.4 ou version ultérieure. Il est disponible dans le framework Zend et en tant que téléchargement distinct. Pour interagir avec Blogger, utilisez la version 1.0.0 ou ultérieure de la bibliothèque cliente.

Créer un compte Blogger

Vous pouvez vous inscrire à un compte Blogger à des fins de test. Blogger utilise des comptes Google. Si vous possédez déjà un compte Google, vous êtes prêt.

Exécuter l'exemple de code

Un exemple de client entièrement fonctionnel, contenant tous les exemples de code présentés dans ce document, est disponible dans le dépôt SVN du framework Zend. L'exemple se trouve à l'adresse /framework/standard/trunk/demos/Zend/Gdata/Blogger.php. L'exemple contient toutes les fonctions expliquées dans ce document. Il ne peut être exécuté qu'à partir de la ligne de commande:

php Blogger.php -- --user=[email_address] --pass=[password]

Avant d'exécuter cet exemple ou de développer votre propre code à l'aide du framework Zend, vous devrez peut-être définir include_path et charger les classes appropriées. Le chemin d'inclusion peut être défini à l'aide d'un paramètre php.ini ou de la méthode set_include_path. Ce code demande l'accès à la classe de base Zend_Gdata, à la classe Zend_Gdata_Query et à la classe d'authentification Zend_Gdata_ClientLogin.

require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata');
Zend_Loader::loadClass('Zend_Gdata_Query');
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');

Utiliser des getters et des setters magiques

Dans la bibliothèque cliente PHP, la prise en charge des setters/getters magiques a été ajoutée pour faciliter la tâche des développeurs. Ils permettent d'accéder de manière sécurisée aux propriétés d'une classe à l'aide de méthodes setter/getter traditionnelles ou en accédant aux propriétés. Par exemple, si $gdataObject est une instance d'un objet dans cette bibliothèque, les deux lignes de code suivantes ont des effets identiques:

$gdataObject->setFoo("bar");
$gdataObject->foo = "bar";

De même, ces deux lignes de code ont également des effets identiques:

$baz = $gdataObject->getFoo();
$baz = $gdataObject->foo;

De même, les méthodes de fabrique magiques facilitent la déclaration de nouveaux objets. Au lieu de mémoriser les longs noms de classe imposés par la convention d'attribution de noms Zend, vous pouvez créer un object en appelant newObject(); sur un client de service Zend. Par exemple, les deux extraits suivants déclarent tous deux un nouvel objet d'extension draft. Pour en savoir plus sur drafts, consultez la section Créer un post.

// Traditional instantiation
$gdClient = new Zend_Gdata();
$draft = new Zend_Gdata_App_Extension_Draft();

// Magic factory instantiation
$gdClient = new Zend_Gdata();
$draft = $gdClient->newDraft();

Les setters/getters et les usines magiques sont facultatifs. Utilisez donc l'approche qui vous convient le mieux.

Autres ressources

Autres ressources pour le composant des API Google Data du framework Zend (Zend_Gdata):

S'authentifier auprès du service Blogger

Vous pouvez accéder aux flux publics et privés à l'aide de l'API Blogger Data. Les flux publics ne nécessitent aucune authentification, mais ils sont en lecture seule. Si vous souhaitez modifier des blogs, votre client doit s'authentifier avant de demander des flux privés. Il peut s'authentifier à l'aide de l'une des trois approches suivantes: authentification OAuth, authentification par proxy AuthSub ou authentification nom d'utilisateur/mot de passe ClientLogin.

Pour en savoir plus sur l'authentification avec les API Google Data en général, consultez la documentation sur l'authentification.

La plupart des exemples des sections suivantes de ce document supposent que vous disposez d'un objet client authentifié appelé $gdClient.

Authentification OAuth

Pour en savoir plus sur l'authentification OAuth à l'aide de la bibliothèque GData PHP Zend, consultez OAuth dans les bibliothèques clientes du protocole Google Data.

Authentification par proxy AuthSub

L'authentification par proxy AuthSub est utilisée par les applications Web qui doivent authentifier leurs utilisateurs auprès de comptes Google. L'opérateur du site Web et le code client n'ont pas accès au nom d'utilisateur et au mot de passe de l'utilisateur Blogger. À la place, le client obtient des jetons AuthSub spéciaux qui lui permettent d'agir au nom d'un utilisateur particulier. Pour en savoir plus, consultez la documentation AuthSub.

Lorsqu'un utilisateur accède à votre application pour la première fois, il n'est pas encore authentifié. Dans ce cas, vous devez afficher des informations et un lien redirigeant l'utilisateur vers une page Google pour authentifier votre demande d'accès à ses blogs. La bibliothèque cliente Zend fournit une fonction permettant de générer l'URL de la page Google. Le code ci-dessous récupère l'URL de la page AuthSubRequest:

function getAuthSubUrl()
{
  $next = getCurrentUrl();
  $scope = 'http://www.google.com/blogger/feeds/';
  $secure = false;
  $session = true;
  return Zend_Gdata_AuthSub::getAuthSubTokenUri($next, $scope, $secure, $session);
}

$authSubUrl = getAuthSubUrl();
echo '<a href=\"$authSubUrl\">login to your Google account</a>';

La méthode getAuthSubTokenUri utilise les paramètres suivants (correspondant aux paramètres de requête utilisés par le gestionnaire AuthSubRequest):

suivant: URL de la page vers laquelle Google doit rediriger l'utilisateur après l'authentification.
champ d'application: Indique que l'application demande un jeton pour accéder aux flux Blogger. La chaîne de portée à utiliser est http://www.blogger.com/feeds/ (encodée au format URL, bien entendu).
sécurisé: Indique si le client demande un jeton sécurisé.
session: Indique si le jeton renvoyé peut être échangé contre un jeton à usage multiple (session).

L'exemple ci-dessus montre un appel qui ne demande pas de jeton sécurisé (la valeur de secure est false). L'URL de requête obtenue peut se présenter comme suit:

https://www.google.com/accounts/AuthSubRequest?scope=http%3A%2F%2Fwww.blogger.com%2Ffeeds%2F&session=1&secure=0&next=http%3A%2F%2Fwww.example.com%2Fwelcome.php

L'utilisateur suit le lien vers le site de Google et s'authentifie avec son compte Google.

Une fois l'utilisateur authentifié, le système AuthSub le redirige vers l'URL que vous avez spécifiée dans le paramètre de requête next de l'URL AuthSubRequest. Le système AuthSub ajoute un jeton d'authentification à cette URL, en tant que valeur du paramètre de requête token. Exemple :

http://www.example.com/welcome.php?token=yourAuthToken

Vous pouvez récupérer la valeur du jeton à l'aide de $_GET['token'].

Cette valeur de jeton représente un jeton AuthSub à usage unique. Dans cet exemple, comme $session = true a été spécifié, ce jeton peut être échangé contre un jeton de session AuthSub à l'aide de la méthode Zend_Gdata_AuthSub::getAuthSubSessionToken, qui appelle le service AuthSubSessionToken:

if(! isset($_SESSION['sessionToken']) && isset($_GET['token'])) {
  $_SESSION['sessionToken'] =
      Zend_Gdata_AuthSub::getAuthSubSessionToken($_GET['token']);
}

L'extrait de code vérifie d'abord si un jeton de session AuthSub est déjà présent. Si ce n'est pas le cas, mais qu'un jeton à usage unique est spécifié dans l'URL, l'extrait de code transmet le jeton à usage unique à la méthode getAuthSubSessionToken, et l'interface AuthSub renvoie un jeton de session. Le code place ensuite la valeur du jeton de session dans la variable de session $_SESSION['sessionToken'].

Votre application peut ensuite utiliser la valeur du jeton de session dans les interactions ultérieures avec Blogger. Vous pouvez utiliser la méthode Zend_Gdata_AuthSub::getHttpClient pour obtenir un objet Zend_Http_Client dont l'en-tête Authorization est prédéfini pour inclure les identifiants AuthSub:

$client = Zend_Gdata_AuthSub::getHttpClient($_SESSION['sessionToken']);

Authentification par nom d'utilisateur/mot de passe ClientLogin

Utilisez l'authentification ClientLogin si votre client est un client "installé" autonome et à un seul utilisateur (par exemple, une application de bureau).

Le code suivant utilise la méthode Zend_Gdata_ClientLogin::getHttpClient pour envoyer une requête au service ClientLogin, récupérer un jeton d'authentification et créer un objet Zend_Http_Client avec l'en-tête d'authentification approprié. Ensuite, l'HttpClient renvoyé par cette méthode est utilisé pour créer un objet de service Zend_Gdata.

Notez que $accountType est explicitement défini sur GOOGLE. Si vous ne définissez pas ce paramètre, les utilisateurs de G Suite ne pourront pas utiliser l'API Blogger.

$user = 'user@example.com';
$pass = 'secretPasswd';
$service = 'blogger';

$client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service, null,
        Zend_Gdata_ClientLogin::DEFAULT_SOURCE, null, null,
        Zend_Gdata_ClientLogin::CLIENTLOGIN_URI, 'GOOGLE');
$gdClient = new Zend_Gdata($client);

Pour en savoir plus sur l'authentification ClientLogin, y compris sur les exemples de requêtes et de réponses, consultez la documentation Authentification pour les applications installées.

Remarque: Utilisez le même jeton pour toutes les requêtes d'une session donnée. N'obtenez pas de nouveau jeton pour chaque requête Blogger.

Remarque: Comme décrit dans la documentation ClientLogin, la requête d'authentification peut échouer et demander un défi CAPTCHA. Si vous souhaitez que Google émette et gère le test CAPTCHA, redirigez l'utilisateur vers https://www.google.com/accounts/DisplayUnlockCaptcha?service=blogger (plutôt que vers l'URL de gestion du CAPTCHA indiquée dans la documentation ClientLogin).

Récupérer une liste de blogs

L'API Blogger Data fournit un flux qui liste les blogs d'un utilisateur donné. Ce flux est appelé "metaflux".

L'exemple de code suivant utilise un objet $gdClient authentifié pour récupérer le métaflux, puis imprime le titre de chaque blog.

La classe Zend_Gdata_Query se charge de créer l'URL de la requête. Dans ce cas, aucune tâche supplémentaire n'est requise, mais l'utilité de la classe Query deviendra évidente dans la section Récupération des posts par paramètres de requête de ce document.

function printAllBlogs()
{
  $query = new Zend_Gdata_Query('http://www.blogger.com/feeds/default/blogs');
  $feed = $gdClient->getFeed($query);
  printFeed($feed);
}

function printFeed($feed)
{
  $i = 0;
  foreach($feed->entries as $entry) {
    print $i ." ". $entry->title->text . "\n";
    $i++;
  }
}

Notez l'URL utilisée par la méthode getFeed. Il s'agit de l'URL du métaflux par défaut. Elle renvoie la liste des blogs de l'utilisateur actuellement authentifié. Pour accéder à un flux pour un autre utilisateur, vous pouvez remplacer default par l'ID de l'utilisateur dans l'URL du métaflux. L'ID de l'utilisateur correspond à la chaîne de chiffres située à la fin de l'URL de son profil.

L'extrait de code ci-dessous montre comment extraire un ID de blog du flux. Vous aurez besoin de l'ID du blog pour effectuer des opérations de création, de modification et de suppression sur les posts et les commentaires. La variable $index représente le blog utilisé dans le flux de blogs de l'utilisateur. Le champ id prend la forme tag:blogger.com,1999:user-userID.blog-blogID. Par conséquent, un split sur le caractère "-" place l'ID du blog dans le dernier élément du tableau obtenu.

$idText = split('-', $feed->entries[$index]->id->text);
$blogID = $idText[2];

Créer des posts

L'API Blogger Data vous permet de créer et de publier des articles de blog, ainsi que des brouillons d'articles.

Remarque: Il n'est actuellement pas possible de définir un auteur personnalisé pour les posts. Tous les nouveaux posts apparaîtront comme s'ils avaient été créés par l'utilisateur actuellement authentifié.

Publier un article de blog

Vous pouvez utiliser la bibliothèque cliente PHP pour publier de nouveaux articles de blog.

Commencez par créer une instance d'entrée pour représenter l'article de blog. Vous pouvez ensuite définir le titre, le contenu et d'autres attributs de l'article de blog. Enfin, appelez la méthode insertEntry pour insérer le post. Vous pouvez voir les instanciations de fabrique magiques à l'œuvre ici avec les nouveaux objets Zend_Gdata_Entry, Zend_Gdata_App_Extension_Title et Zend_Gdata_App_Extension_Content.

function createPublishedPost($title='Hello, world!', $content='I am blogging on the internet.')
{
  $uri = 'http://www.blogger.com/feeds/' . $blogID . '/posts/default';
  $entry = $gdClient->newEntry();
  $entry->title = $gdClient->newTitle($title);
  $entry->content = $gdClient->newContent($content);
  $entry->content->setType('text');

  $createdPost = $gdClient->insertEntry($entry, $uri);
  $idText = split('-', $createdPost->id->text);
  $newPostID = $idText[2];

  return $newPostID;
}

Créer un brouillon d'article de blog

Les posts brouillons sont créés de la même manière que les posts publics, mais vous devez définir l'attribut "brouillon" de l'objet "entrée". Vous pouvez créer un brouillon de post de blog comme celui ci-dessus en ajoutant les lignes en surbrillance:

function createDraftPost($title='Salutations, world!', $content='Hmm ... not quite right, must rework the title later.')
{
  $uri = 'http://www.blogger.com/feeds/' . $blogID . '/posts/default';
  $entry = $gdClient->newEntry();

  $entry->title = $gdClient->newTitle(trim($title));
  $entry->content = $gdClient->newContent($content);
  $entry->content->setType('text');

  $control = $gdClient->newControl();
  $draft = $gdClient->newDraft('yes');
  $control->setDraft($draft);
  $entry->control = $control;

  $createdPost = $gdClient->insertEntry($entry, $uri);
  $idText = split('-', $createdPost->id->text);
  return $idText[2];
}

De la même manière que vous définissez le titre ou le contenu d'un post, vous créez des objets Zend_Gdata_App_Extension_Control et Zend_Gdata_App_Extension_Draft, puis les attribuez à l'attribut de contrôle de l'entrée.

Vous pouvez transformer un brouillon d'article de blog existant en article publié en récupérant le brouillon, en définissant l'attribut "brouillon" sur no, puis en mettant à jour l'article. Nous verrons comment récupérer et mettre à jour des posts dans les deux sections suivantes.

Récupérer des posts

Les sections suivantes expliquent comment récupérer une liste d'articles de blog, avec et sans paramètres de requête.

Vous pouvez interroger un flux public Blogger sans authentification. Par conséquent, vous n'avez pas besoin de définir d'identifiants ni d'effectuer d'authentification AuthSub avant de récupérer des posts à partir d'un blog public.

Récupérer tous les articles de blog

Pour récupérer les posts de l'utilisateur, appelez la même méthode getFeed utilisée pour récupérer le métaflux des blogs, mais cette fois, envoyez l'URL du flux de posts de blog:

function printAllPosts($gdClient, $blogID)
{
  $query = new Zend_Gdata_Query('http://www.blogger.com/feeds/' . $blogID . '/posts/default');
  $feed = $gdClient->getFeed($query);
  printFeed($feed);
}

Récupérer des posts à l'aide de paramètres de requête

L'API Blogger Data vous permet de demander un ensemble d'entrées correspondant à des critères spécifiés, par exemple en demandant des articles de blog publiés ou mis à jour dans une plage de dates donnée. Pour ce faire, créez un objet de requête et transmettez-le à la méthode getFeed.

Par exemple, pour envoyer une requête de plage de dates, définissez les paramètres published-min et published-max de l'objet de requête. L'extrait de code suivant affiche le titre et le contenu de chaque article de blog publié entre l'heure de début et l'heure de fin données:

function printPostsInDateRange($gdClient, $blogID, $startDate='2007-04-01', $endDate='2007-04-25')
{
  $query = new Zend_Gdata_Query('http://www.blogger.com/feeds/' . $blogID . '/posts/default');
  $query->setParam('published-min', $startDate);
  $query->setParam('published-max', $endDate);

  $feed = $gdClient->getFeed($query);
  printFeed($feed);
}

Une méthode de débogage utile pour la classe Zend_Gdata_Query est getQueryUrl(), qui affiche l'URL encodée qui a été créée.

Remarque: Il n'existe actuellement aucun setter magique pour les paramètres de requête published-min et published-max. Toutefois, vous pouvez utiliser setStartIndex et setMaxResults.

L'API Blogger Data accepte les paramètres de requête suivants:

catégories: Spécifie des catégories (également appelées "libellés") pour filtrer les résultats du flux. Par exemple, http://www.blogger.com/feeds/blogID/posts/default/-/Fritz/Laurie renvoie les entrées avec les étiquettes Fritz et Laurie.
max-results: Nombre maximal d'entrées à renvoyer.
published-min, published-max: Limites des dates de publication des entrées.
start-index: Index en base 1 du premier résultat à récupérer (pour la pagination).

Pour en savoir plus sur les paramètres de requête, consultez le guide de référence de l'API Blogger Data et le guide de référence des API Google Data.

Mettre à jour des posts

Pour mettre à jour un article de blog existant, vous devez d'abord récupérer l'entrée que vous souhaitez modifier, puis la modifier, puis l'envoyer à Blogger à l'aide de la méthode save. L'extrait de code suivant modifie le titre et le contenu d'un article de blog, en supposant que vous l'avez déjà récupéré sur le serveur.

public function updatePost($postID, $updatedTitle='Hello, World?',
                           $updatedContent='UPDATE: Still blogging',
                           $isDraft=False)
{
  $query = new Zend_Gdata_Query('http://www.blogger.com/feeds/' . $blogID . '/posts/default/' . $postID);
  $postToUpdate = $dClient->getEntry($query);
  $postToUpdate->title->text = $this->gdClient->newTitle($updatedTitle);
  $postToUpdate->content->text = $this->gdClient->newContent($updatedContent);

  if ($isDraft) {
    $draft = $gdClient->newDraft('yes');
  } else {
    $draft = $gdClient->newDraft('no');
  }

  $control = $gdClient->newControl();
  $control->setDraft($draft);
  $postToUpdate->control = $control;

  $updatedPost = $postToUpdate->save();
  return $updatedPost;
}

Remarque: Il n'est pas possible de modifier les données d'auteur associées aux posts.

Supprimer des posts

Pour supprimer un post, transmettez l'URL de modification du post à la méthode delete de votre objet $gdClient, comme suit:

public function deletePost($gdClient, $blogID, $postID)
{
  $uri = 'http://www.blogger.com/feeds/' . $blogID . '/posts/default/' . $postID;
  $gdClient->delete($uri);
}

Commentaires

L'API Blogger Data permet de créer, de récupérer et de supprimer des commentaires. La modification des commentaires n'est pas possible (et n'est pas disponible dans l'interface Web).

Créer des commentaires

Pour publier un commentaire, créez un objet Entry et insérez-le comme suit:

function createComment($gdClient, $blogID, $postID, $commentText)
{
  $uri = 'http://www.blogger.com/feeds/' . $blogID . '/' . $postID . '/comments/default';

  $newComment = $gdClient->newEntry();
  $newComment->content = $gdClient->newContent($commentText);
  $newComment->content->setType('text');
  $createdComment = $gdClient->insertEntry($newComment, $uri);

  $editLink = split('/', $createdComment->getEditLink()->href);
  $newCommentID = $editLink[8];

  return $newCommentID; 
}

Remarque: Actuellement, vous ne pouvez publier des commentaires que sur un blog appartenant à l'utilisateur authentifié.

Remarque: Il n'est actuellement pas possible de définir un auteur personnalisé pour les commentaires. Tous les nouveaux commentaires apparaîtront comme s'ils avaient été créés par l'utilisateur actuellement authentifié.

Récupération des commentaires

Vous pouvez récupérer les commentaires d'un post spécifique à partir de l'URL du flux de commentaires du post:

public function printPostComments($gdClient, $blogID, $postID)
{
  $query = new Zend_Gdata_Query('http://www.blogger.com/feeds/' . $blogID . '/' . $postID . '/comments/default');
  $feed = $gdClient->getFeed($query);
  $printFeed($feed);
}

Vous pouvez également obtenir les commentaires de tous les articles à l'aide de l'URL du flux de commentaires du blog:

http://www.blogger.com/feeds/blogID/comments/default

Suppression des commentaires

Pour supprimer un commentaire, transmettez l'URL de modification du commentaire à la méthode delete de votre objet $gdClient comme suit:

public function deleteComment($gdClient, $blogID, $postID, $commentID)
{
  $uri = 'http://www.blogger.com/feeds/' . $blogID . '/' . $postID . '/comments/default/' . $commentID;
  $gdClient->delete($uri);
}

Haut de page