[doc et exemples Olivier Schwander BUGA **20081010180630] { adddir ./doc addfile ./doc/documentation.html hunk ./doc/documentation.html 1 + + + hunk ./doc/documentation.html 5 + + + + + + + + + + + + + Vie de merde : Vos histoires de la vie quotidienne + + + + +
+
+
En partenariat avec Premiere.fr
+
+
Nouveau : Recherche avancée
+
+ +
+
+
Vie de merde
+
Ma vie c'est de la merde, et je vous emmerde
+
+

Accueil

-
+

FAQ

-
+

API 1.2

-
+

Le Top

-
+

Le Flop

-
+

VDM aléatoire

-
+

Boutique VDM

-
+

Soumettez votre VDM

-
+

Modérez les VDM

+
+
+
+ +
+

Soumettez votre vie de merde :


+
  • - Rappel du concept : Une anecdote qui commence par "Aujourd'hui" et qui se termine par "VDM".
    • +
  • - Attention : Relisez-vous. Une anecdote écrite en SMS ou comportant trop de fautes d'orthographe est toujours refusée.
  • - N'utilisez pas cet espace pour des discussions, de la publicité ou pour tout autre texte n'étant pas une VDM.
+
+
+
Votre pseudo :
Catégorie :
+ +
Être prévenu par e-mail ?
+
+ +
+
+
+ + +
+ +
+

+ Liste des applications | Documentation API | Espace développeurs +

+
+ +
+ +

Documentation de l'API VDM

+ +
+ +

Ci-dessous la description du fonctionnement de l'API VDM, version 1.2.

+ + + +
+ +
+ +

Principe de fonctionnement

+ +

Les appels à l'API doivent être faits avec des requêtes HTTP GET sur le domaine api.viedemerde.fr, du type :

+ +
+ +

GET http://api.viedemerde.fr/1.2/view/last

+ +

Le format de retour est du XML, qui dans sa plus simple expression se résume à cela :

+ +

<root>
+ + ( ... réponse ... )
+ <code>1</code>
+ <erreurs/>
+</root>

+ +
    +
  • code est à 1 lorsque l'opération est un succès, 0 sinon
    • + +
  • erreurs contient les erreurs dans le cas où le code est à 0
    • +
+ +

Les retours XML ne sont pas expliqués dans les détails, faites des +tests par vous-même, ils sont suffisamment explicites pour ne pas avoir +à les documenter :)

+ +

Pour effectuer des tests sans affecter la base de données, vous pouvez désormais utiliser sandbox.viedemerde.fr comme serveur à la place de l'habituel api.viedemerde.fr.

+ +
+ +
+ +

Clé de développement

+ +

La version 1.2 apporte une amélioration notable par rapport à la version 1.1 pour ce qui est de la clé de développement.

+ +

Beaucoup d'applications utilisant l'API VDM se basant sur la version +1.0 n'utilisent que des fonctions qui ne font pas appel à une action +qui modifie quelque chose sur le site. C'est pourquoi dans la version +1.2 nous avons repris ce système en proposant une clé lecture seule. + +

Cette clé lecture seule vous permet donc d'utiliser l'API pour +toutes les actions qui ne requièrent pas d'identification du membre :

+ +

?key=readonly

+ +

A noter que si vous fournissez une mauvaise clé de développement, vous passez automatiquement en lecture seule.

+ +

Pour pouvoir utiliser complètement l'API en revanche, vous devez +disposer d'une clé de développement. Aucune contrainte particulière +n'est appliquée, vous devez simplement en faire la demande dans l'espace développeurs, vous recevrez une clé instantanément par e-mail.

+ +

Une fois que vous disposez de cette clé, vous devez toujours la mentionner en paramètre de vos appels à l'API :

+ +

?key=XXXXXXXXXXXXX

+ +

Cette clé nous permet de faire de meilleures statistiques sur +l'utilisation de l'API, et ainsi de pouvoir l'améliorer plus facilement +et rapidement. Grâce à cette clé nous pourrons aussi vous contacter +pour les mises à jour majeures de l'API.

+ +
+ +
+ +

Identification membres

+ +

Pour plus de sécurité, vous ne pouvez pas demander aux membres de +vous donner leurs identifiants via l'API. Le membre doit aller sur une +URL du type ci-dessous :

+ +

http://www.viedemerde.fr/compte/token/<votre clé API>

+ +

Sur cette URL le membre confirmera qu'il veut vous donner accès à +son compte membre et il recevra une chaîne de caractère appelée token, +dont vous aurez besoin pour effectuer des actions sur son compte via +l'API :

+ +

&token=XXXXXXXXXXXXX

+ +
+ +
+ +

Action /view

+ +

Affiche les VDM de plusieurs façons :

+ +

GET http://api.viedemerde.fr/1.2/view/last[/page]

+ +

Affiche les dernières VDM postées sur le site par page de 15.

+ +

GET http://api.viedemerde.fr/1.2/view/random

+ +

Affiche une VDM au hasard avec ses commentaires.

+ +

GET http://api.viedemerde.fr/1.2/view/top[/page]

+ +

Affiche le top VDM. Pour préciser un intervalle, changer le paramètre en : top_jour / top_semaine / top_mois

+ +

GET http://api.viedemerde.fr/1.2/view/flop[/page]

+ +

Affiche le flop VDM. Pour préciser un intervalle, changer le paramètre en : flop_jour / flop_semaine / flop_mois

+ +

GET http://api.viedemerde.fr/1.2/view/[cat][/page]

+ +

Affiche les dernières VDM de la catégorie nommée, par page de 15. Le paramètre peut être : amour / argent / travail / + +sante / sexe / inclassable

+ +

GET http://api.viedemerde.fr/1.2/view/[numero][/nocomment]

+ +

Affiche la VDM #[numero] avec ses commentaires. Rajoutez le paramètre /nocomment pour ne pas afficher les commentaires.

+ +

POST http://api.viedemerde.fr/1.2/view/recherche/?recherche=[recherche]

+ +

Affiche les VDM correspondant à la recherche. Pour connaître les astuces, rendez-vous sur la page dédiée à la recherche sur VDM. Attention, se passe en POST !

+ +

GET http://api.viedemerde.fr/1.2/view/categories

+ +

Affiche les catégories disponibles sur le site.

+ +

GET http://api.viedemerde.fr/1.2/view/new

+ +

Affiche les VDM non-lues du membre.

+ +

GET http://api.viedemerde.fr/1.2/view/favoris

+ +

Affiche les VDM favorites du membre.

+ +
+ +
+ +

Action /vote

+ +

Cette action permet de voter via l'API pour les VDM. Cette fonction est réservée aux membres VDM (token).

+ +

GET http://api.viedemerde.fr/1.2/vote/[numero]/[type]

+ +

Unique fonction de l'action vote, remplacer par le numéro de la VDM à voter, et type peut être : je_valide / bien_merite

+ +
+ +
+ +

Action /submit

+ +

Envoie une VDM :

+ +

GET http://api.viedemerde.fr/1.2/submit

+ +

Attention, les éléments du formulaire se passent en paramètres :

+ +

&auteur= // Auteur de la VDM
+&cat= // Catégorie
+&texte= // Texte
+&mail= // Mail (facultatif)

+ +

La catégorie peut être : amour / argent / travail / sante / sexe / +inclassable. Les mêmes restrictions que la soumission d'une VDM via le +site s'appliquent : Limitation de 300 caractères notamment.

+ +
+ +
+ +

Action /comment

+ +

Envoie un commentaire sur une VDM :

+ +

GET http://api.viedemerde.fr/1.2/comment

+ +

Attention, les éléments du formulaire se passent en paramètres :

+ +

&id= // ID de la VDM
+&texte= // Texte
+&url= // Site web (facultatif)

+ +

L'utilisateur qui poste un commentaire doit être membre de VDM et identifié via l'API (token).

+ +
+ +
+ +

Action /mod

+ +

Intégration de l'auto-modération dans l'API :

+ +

GET http://api.viedemerde.fr/1.2/mod/last

+ +

Affiche la dernière VDM à modérer.

+ +

GET http://api.viedemerde.fr/1.2/mod/view[/numero]

+ +

Dans le [numero], cette commande renvoie la liste de toutes les VDM +restant à modérer. Avec le numéro, elle affiche une VDM en particulier.

+ +

GET http://api.viedemerde.fr/1.2/mod/[oui|non]/[numero]

+ +

Modère selon si OUI ou NON la VDM en question doit être acceptée sur le site.

+ +
+ +
+ +

Action /compte

+ +

Utilitaires pour les comptes membre :

+ +

GET http://api.viedemerde.fr/1.2/compte/infos

+ +

Renvoie les informations du compte identifié.

+ +

GET http://api.viedemerde.fr/1.2/compte/logout/[token]

+ +

Supprime le token de la base de l'API pour déconnecter le membre de manière sûre.

+ +
+ +
+ +

Action /dev

+ +

GET http://api.viedemerde.fr/1.2/dev

+ +

Affiche plusieurs statistiques sur votre compte développeur.

+ +
+ +
+
+
+
Catégories
+ +
+
+
Votre compte
+
+
+ + +
+
Inscription
+
Mot de passe ?
+
+
+
+
+

Blog de l'équipe

+ +
+
+ +
+
+

© 2008.

+ +
+
+
+
+ + + + + adddir ./examples addfile ./examples/last.pl hunk ./examples/last.pl 1 +#! /usr/bin/perl -I../lib + +use WWW::VieDeMerde; + +my $vdm = WWW::VieDeMerde->new(); + +print $vdm->last(); + }