Premiers pas

L'API de VDM donne accès en JSON à ce qu'on trouve sur viedemerde.fr : les VDM publiées, leurs commentaires, les profils des membres et leurs badges. Avec le compte d'un membre, elle permet aussi de voter, de commenter et de publier une VDM.

Obtenir une clé

Chaque requête doit porter une clé d'API, qui identifie votre application. Connectez-vous avec votre compte VDM dans Mes clés et créez-en une : elle est active tout de suite. Si l'API est appelée depuis un navigateur, limitez la clé à votre domaine pour qu'on ne puisse pas la réutiliser ailleurs.

Faire une requête

L'API est servie à https://www.viedemerde.fr/api/v2. Passez la clé dans l'en-tête X-VDM-Api-Key :

Shell

curl -g "https://www.viedemerde.fr/api/v2/article/list?page[number]=1&page[bypage]=10" \
  -H "X-VDM-Api-Key: $API_KEY"

Ou depuis JavaScript :

JavaScript

const response = await fetch("https://www.viedemerde.fr/api/v2/article/123456", {
  headers: { "X-VDM-Api-Key": process.env.API_KEY },
});
const { data: story } = await response.json();

Format des réponses

Les réponses sont en JSON (UTF-8). Le résultat est dans data, et meta peut contenir des informations en plus. badge et badge_display listent les badges que le membre vient de gagner avec cette requête (vide le plus souvent) :

JSON

{
  "data": [ … ],
  "meta": {},
  "badge": [],
  "badge_display": []
}

Les dates sont au format ISO 8601. Les listes se paginent avec page[number] (à partir de 1) et page[bypage]. Les filtres qui acceptent plusieurs valeurs s'écrivent avec des crochets, comme status[]=4&status[]=12 : avec curl, ajoutez -g pour qu'il ne les interprète pas.

En-têtes

En-tête	Rôle
`X-VDM-Api-Key`	Votre clé d'API. Obligatoire sur toutes les requêtes, et renvoyée dans la réponse.
`X-VDM-Api-Token`	Le jeton d'un membre connecté, pour agir en son nom (voir Connecter un membre).
`X-VDM-Uniqid`	Sans membre connecté : un identifiant stable de l'appareil, obtenu une fois avec `GET /user/uniqid` puis gardé. Obligatoire pour voter ou signaler une VDM : chaque appareil ne compte qu'une fois.

Bonnes pratiques

Mettez les listes en cache quelques minutes plutôt que de les redemander à chaque affichage : les VDM sont publiées quelques fois par jour.
Quand vous affichez une VDM, citez VDM et faites un lien vers la VDM sur viedemerde.fr.
N'enregistrez jamais le mot de passe d'un membre : gardez seulement son jeton.