VDMDéveloppeurs

Badges

Récupérer un badge par son id

GET/badge/{badgeid}Jeton membre obligatoire

Jeton utilisateur obligatoire. Renvoie 404 si le badge n’existe pas.

Paramètres

badgeidobligatoiredans l'URLformat \d+
entier, obligatoire — id du badge

Valeurs

category : 1 => bronze | 2 => silver | 3 => gold
Requête
curl "https://www.viedemerde.fr/api/v2/badge/{badgeid}" \
  -H "X-VDM-Api-Key: $API_KEY" \
  -H "X-VDM-Api-Token: $TOKEN"
Réponse 200
{
  "data": {
    "id": 1,
    "site": null,
    "name": "Débutant",
    "description": "Vous avez parcouru 5 pages du site. C'est un début.",
    "hidden": "0",
    "goal": 5,
    "limited": "0",
    "category": 1,
    "total": 7698968,
    "illustration": "lI6nHr5hWXlu0.gif"
  },
  "meta": {},
  "badge": [],
  "badge_display": []
}

Réponse réelle de l'API, sur des données de test. Les listes sont coupées à 2 éléments.

Erreurs possibles

401

{
  "data": [
    "Vous devez être authentifié pour accéder à cette fonction."
  ],
  "meta": {},
  "badge": [],
  "badge_display": []
}

404

{
  "data": "Badge not found.",
  "meta": {},
  "badge": [],
  "badge_display": []
}

Lister les badges

GET/badge/listJeton membre obligatoire

Jeton utilisateur obligatoire. Renvoie tous les badges, sauf les badges cachés.

Paramètres

Aucun paramètre.

Valeurs

category : 1 => bronze | 2 => silver | 3 => gold
Requête
curl "https://www.viedemerde.fr/api/v2/badge/list" \
  -H "X-VDM-Api-Key: $API_KEY" \
  -H "X-VDM-Api-Token: $TOKEN"
Réponse 200
{
  "data": [
    {
      "id": 1,
      "site": null,
      "name": "Débutant",
      "description": "Vous avez parcouru 5 pages du site. C'est un début.",
      "hidden": "0",
      "goal": 5,
      "limited": "0",
      "category": 1,
      "total": 7698968,
      "illustration": "lI6nHr5hWXlu0.gif"
    },
    {
      "id": 2,
      "site": null,
      "name": "Profil rempli",
      "description": "Vous avez le souci du détail. Voilà qui sera apprécié.",
      "hidden": "0",
      "goal": 1,
      "limited": "0",
      "category": 1,
      "total": 192675,
      "illustration": "2.gif"
    }
  ],
  "meta": {},
  "badge": [],
  "badge_display": []
}

Réponse réelle de l'API, sur des données de test. Les listes sont coupées à 2 éléments.

Erreurs possibles

401

{
  "data": [
    "Vous devez être authentifié pour accéder à cette fonction."
  ],
  "meta": {},
  "badge": [],
  "badge_display": []
}