Amis développeurs, vous avez maintenant la possibilité de créer vos propres applications en utilisant notre contenu : Voici ci-dessous la documentation de l'API VDM version 1.0 !
Principe de fonctionnement
Il n'y a pas d'identification nécessaire pour utiliser l'API, pour le moment. 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.0/view/last
Le format de retour est du XML, qui dans sa plus simple expression se résume à cela :
( ... réponse ... )
1
- 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
Vous pouvez télécharger le fichier DTD correspondant aux réponses ici : api.xsd. Merci à Seregon !
Passons maintenant aux fonctions.
Action /view
Affiche les VDM de plusieurs façons :
GET http://api.viedemerde.fr/1.0/view/last[/page]
Affiche les dernières VDM postées sur le site par page de 15.
GET http://api.viedemerde.fr/1.0/view/random
Affiche une VDM au hasard avec ses commentaires.
GET http://api.viedemerde.fr/1.0/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.0/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.0/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.0/view/[numero][/nocomment]
Affiche la VDM #[numero] avec ses commentaires. Rajoutez le paramètre /nocomment pour ne pas afficher les commentaires.
Action /vote
Cette action permet de voter via l'API pour les VDM. Note : Vous devez être capable de gérer les cookies pour pouvoir voter, sinon l'API retournera une erreur.
GET http://api.viedemerde.fr/1.0/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
Je pense avoir fait le tour de cette documentation. 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 :)
Si vous réalisez une application ou faites un développement à partir de cette API, surtout faites le nous savoir pour que nous en parlions sur le blog !
Chargement...