Mise à jour de la librairie PHP pour TypePad

Le 2 septembre 2011 // Ajouté dans Développement, PHP, Tutoriels  

Aujourd’hui, un billet traitant de la plate-forme de blogs TypePad et de son API permettant de récupérer du contenu associé à un utilisateur.

TypePad

TypePad est un service de blogs conçu par la société Six Apart et lancé en octobre 2003.
N’allant pas jusqu’à étaler ici la définition présente sur Wikipedia (lien), j’ajouterai cependant qu’il s’agit d’un service payant et donc peut-être plus orienté professionnel.

L’API

L’API TypePad permet de récupérer des contenus en relation avec l’utilisateur authentifié.
Comme bon nombre d’API de réseau social aujourd’hui, elle se base sur la méthode authentification OAuth avec un système de clé d’accès (token).

TypePad mets à disposition des développeurs une librairie (ou SDK) PHP permettant de faciliter le travail d’intégration de l’API sur un projet.

Bien que fonctionnelle, elle semble dater quelque peu et il y a toutes les raisons de croire qu’elle a d’abord été conçue en PHP 4 puis a subi un portage vers le PHP 5.
Je suis cependant plus réservé quant au portage vers la version 5 de PHP.

Quoi qu’il en soit, la librairie que TypePad propose nécessite de disposer d’une base de donnée MySQL, dont les noms de table et de champs sont déjà définis.
Ma première stupéfaction a été de voir qu’ils n’étaient même pas préfixés !

Ainsi, on trouve la table user pour stocker les utilisateurs s’étant connecté à l’API. Il est vrai que le nom user pour un site web (avec base de donnée bien entendu) n’est que rarement utilisé !
Alors si vous aussi vous avez le malheur d’utiliser des noms logiques pour le nom de vos tables comment faites-vous ?
Trêve de plaisanterie.

Une première solution consisterai à utiliser deux bases de donnée, une pour votre site et l’autre dédié à l’API TypePad.
Avouez tout de même que c’est tiré par les cheveux ! Si l’on devait raisonner ainsi avec toutes les API, nous ne serions pas rendu !
D’autant que bon nombre d’hébergeur standard du web ne propose pas plusieurs bases de donnée !

Autre solution envisagée, aller modifier une par une les lignes du code source du SDK pour remplacer les noms de ces tables, pour correspondre à celles que vous avez choisies, et ajouter des majuscules par la même occasion (parce que c’est plus « POO style » ;-) ).

Ces deux solution ne me convenait tout simplement pas !
D’une part parce qu’elle demandait toujours une base de donnée, bien que j’en utilise une. Et d’autre part parce que j’estime que l’on a pas besoin de stocker autant d’informations à propos d’une API (le SDK de TypePad stocke des informations sur l’API, ainsi que les différentes clés échangées avec le serveur).
La contrainte d’une base de donnée est bien trop lourde pour une simple authentification via un réseau.

Il ne restait donc plus qu’une solution : mettre à jour le SDK !

Nouvelle version

J’ai donc entrepris de mettre à jour la librairie PHP pour l’API TypePad en me basant sur ce qui se fait pour d’autres API (LinkedIn, Facebook, etc.).
Sans aller jusqu’à tout revoir sur le SDK (après tout, il fonctionnait correctement), il m’aura fallu 1 journée complète pour le mettre à jour.

Au final, je pense avoir réussi mon pari, non sans pouvoir assurer qu’aucun bug ne persiste.
L’utilisation de la librairie quant à elle ne diffère pas beaucoup du fonctionnement initial ; avec l’utilisation de la base de donnée en moins tout de même et une utilisation un peu plus claire.

Je ne vous parle pas également de l’utilisation de cookie pour stocker les informations sur l’utilisateur dans la précédente version !
Non seulement cela manquait de sécurité, mais en plus cela posait problèmes lors de reconnexion (les modifications apportées à un cookie ne sont en effet prise en compte que lors de la prochaine requête).
Les informations sont dorénavant stockées en session et effacées lorsqu’elles ne sont plus utiles.

Utilisation

Nous allons ici travailler en étape. Voyez cela comme un petit tutoriel pour utiliser la librairie.

1 – Commencez par demander une clé API sur TypePad (lien). Pour cela, vous aurez besoin d’un compte TypePad bien entendu.

Bien que l’accès soit payant, une période d’essai de 15 jours est proposée ; à condition de fournir votre numéro de carte bleue tout de même…
Note : Pensez aux e-cartes bleue, sécurisé et pouvant être détruite ! Vous n’êtes en effet débité qu’au bout des 15 jours d’essais.

Lors de la demande de clé, sachez que le champs « URL du site » n’a pas grande importance pour l’utilisation de l’API.

2 – Une fois votre demande effectuée, vous obtenez 2 séries de valeurs (la clé et la clé secrète) dites consommateur et anonyme.

Vous aurez besoin de toutes ces valeurs.
Renseignez les quelques part sur votre application web et veuillez à ce qu’elles ne soient pas accessible du public.

3 – Intégrer la librairie mise à jour (lien).

4 – Créez une instance de la classe TypePad en fournissant les deux jeux de clés et clés secrètes.

L’obtention de l’autorisation d’accès au compte de l’utilisateur s’effectue en deux étapes.
Bien que cela diffère des méthodes des réseaux actuels, je n’ai pas pu réduire cela à une seule étape (et donc une seule redirection).

Rapide explication : Tout d’abord, nous demandons à l’utilisateur de se connecter sur TypePad depuis le domaine typepad.com.
Une fois connecté, ou s’il l’était déjà, TypePad renvoi l’utilisateur vers une url sur votre site, afin que vous puissiez demander cette fois-ci l’autorisation d’accès à son compte (cette url était anciennement appelée « url de synchronisation »).

L’utilisateur se voit donc rediriger à nouveau vers typepad.com pour cette fois-ci accepter que votre API TypePad accède aux données de son compte.
Enfin, l’utilisateur est redirigé une dernière fois vers votre site où vous pourrez enfin récupérer les clés d’accès finales.

Ci-dessous un schéma représentant le cheminement de l’utilisateur décrit ci-dessus.

  1. $url = "http://" . $_SERVER[‘HTTP_HOST’] . $_SERVER[‘PHP_SELF’];
  2. $consumer_key = ‘…’;
  3. $consumer_secret = ‘…’;
  4. $purpose_key = ‘…’;
  5. $purpose_secret = ‘…’;
  6.  
  7. $typepad = new TypePad($consumer_key, $consumer_secret, $purpose_key, $purpose_secret);

5 – Appelez la méthode login de votre instance de classe TypePad en fournissant l’url d’autorisation ainsi que l’url de retour.

  1. $typepad->login(
  2.         $url . ‘?tpauthorize=1′,
  3.         $url . ‘?tpfinal=1′
  4. );
  5. exit();

6 – Une fois authentifié, sur la page correspondant à l’url d’autorisation, appelez la méthode authorize en fournissant les variables session_sync_token et callback_next présente dans l’url.

  1. $typepad->authorize(
  2.         $_GET[’session_sync_token’],
  3.         $_GET[‘callback_next’]
  4. );
  5. exit();

7 – Echangez vos clés temporaires contres les finales grâce à la méthode getAccessToken.

  1. $tokens = $typepad->getAccessToken($_GET[‘oauth_token’], $_GET[‘oauth_verifier’]);

8 – L’utilisateur étant authentifié, vous pouvez désormais accéder aux informations le concernant par le biais des indications présentent sur cette page : Lien

Ci-dessous un exemple concret de mise en place de l’API.

  1. <?php
  3. require_once("library/TypePad.php");
  4.  
  5. $url = "http://" . $_SERVER[‘HTTP_HOST’] . $_SERVER[‘PHP_SELF’];
  6. $consumer_key = ‘…’;
  7. $consumer_secret = ‘…’;
  8. $purpose_key = ‘…’;
  9. $purpose_secret = ‘…’;
  10.  
  11. $typepad = new TypePad($consumer_key, $consumer_secret, $purpose_key, $purpose_secret);
  12. if (isset($_SESSION[‘tptokens’]))
  13.         $typepad->setTokens($_SESSION[‘tptokens’][‘token’], $_SESSION[‘tptokens’][‘token_secret’]);
  14.  
  15. //Request process
  16.         //Check authentification
  17. if (isset($_GET[‘tp’])) {
  18.  
  19.         unset($_SESSION[‘tptokens’]);
  20.         $typepad->logout();
  21.         $typepad->login(
  22.                 $url . ‘?tpauthorize=1′,
  23.                 $url . ‘?tpfinal=1′
  24.         );
  25.        
  26.         //Check authorize access
  27. } else if (isset($_GET[‘tpauthorize’])) {
  28.  
  29.         $typepad->authorize(
  30.                 $_GET[’session_sync_token’],
  31.                 $_GET[‘callback_next’]
  32.         );
  33.         exit();
  34.        
  35.         //Get finals tokens
  36. } else if (isset($_GET[‘tpfinal’])) {
  37.  
  38.         $tokens = $typepad->getAccessToken($_GET[‘oauth_token’], $_GET[‘oauth_verifier’]);
  39.        
  40.         $_SESSION[‘tptokens’] = $tokens;
  41.        
  42.         header("Location: " . $url);
  43.         exit();
  44.  
  45.         //Logout
  46. } else if (isset($_GET[‘logout’])) {
  47.        
  48.         unset($_SESSION[‘tptokens’]);
  49.         $typepad->logout();
  50.         header(‘Location: ‘ . $url);
  51.         exit();
  52. }
  53.  
  54. ?>
  55.  
  56. <!DOCTYPE html>
  57. <html>
  58.         <head>
  59.                 <title></title>
  60.                 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  61.         </head>
  62.         <body>
  63.                 <?php
  64.                 if ($typepad->isLoggedIn()) {
  65.                         $me = $typepad->users->get(‘@self’);
  66.                        
  67.                         echo ‘<a href="’ . $url . ‘?logout=1">Déconnexion</a>
  68.  
  69. Bonjour ‘ . $me->displayName . "
  70.  
  71. Voiçi les différents blogs de votre compte :
  72. ";
  73.                         $blogs = $typepad->users->getBlogs($me->urlId);
  74.                         foreach ($blogs->entries as $blog)
  75.                                 echo ‘<a href="’ . $blog->homeUrl . ‘" target="_blank">’ . $blog->homeUrl . ‘</a>
  76. ‘;
  77.                        
  78.                 } else { ?>
  79.                         <a href="<?php echo $url . ‘?tp=1′; ?>">Connexion</a>
  80.                 <?php } ?>
  81.         </body>
  82. </html>
  83.  

Si vous avez des questions concernant la mise en place de l’API TypePad sur votre site, je peux y répondre.
Cependant, sachez que cette librairie n’est pas exempte de bugs. Si vous en rencontrez un, n’hésitez donc pas à me le communiquer.
Il y aura peut-être également certains points à revoir, permettant une utilisation plus souple de l’API.

Ci-après vous trouvez l’archive comportant la librairie mise à jour ainsi que l’exemple d’utilisation présenté ci-dessus.
Comme pour la plupart des éléments que je mets à disposition sur ce blog, vous avez le droit d’utiliser, de redistribuer et de modifier ce code à la seule condition de laisser le nom des auteurs ; à savoir la société Six Apart avant tout, puis mon nom tel qu’il est écrit dans certains fichiers.

Lien de téléchargement

À la prochaine !

Ce billet a été ajouté le 2 septembre 2011 à 17:52:30 et placé dans la catégorie Développement, PHP, Tutoriels (Tags : , , , , , , ). Vous pouvez suivre toutes les réponses de ce billet avec le feed RSS 2.0. Vous pouvez ajouter un commentaire ou faire un lien depuis votre site.

Répondre (nom & email requis)