API

Voici une documentation de l’API d’infop7.org. Toutes les données renvoyées par le serveur sont en JSON. En cas d’erreur, la réponse est invariablement la suivante :

{ "error" : "<texte de l’erreur>" }

Actualités

Récupérer une actualité

Méthode

GET /api/1/news/get_one.json?id=<id>

Paramètres

• id : identifiant unique de l’actualité

Réponse

{
  "data" : {
    "title" : "<titre>",
    "text" : "<texte formaté en HTML>",
    "md_text" : "<texte formaté en Markdown>"
  }
}

Contenus

Derniers contenus ajoutés

Cette méthode retourne les derniers contenus ajoutés qui sont visibles pour l’utilisateur courant.

Méthode

GET /api/1/contents/last.json

Paramètres

• (Optionnel) l : limite (défaut: 10)

Réponse

{
  "data" : [
    {
      "href" : "<URL du contenu>",
      "title" : "<titre du contenu>",
      "date" : "<date du contenu>",
      "cursus" : "<nom du cursus correspondant>",
      "course" : "<nom du cours correspondant>"
    },
    …
  ]
}

Cours

Introduction

Méthode

GET /api/1/course/intro.json?id=<id>

Paramètres

• id : identifiant unique correspondant au cours

Réponse

{
  "data" : {
    "text" : "<texte formaté en HTML>",
    "md_text" : "<texte formaté en Markdown>"
  }
}

Cursus

Introduction

Méthode

GET /api/1/cursus/intro.json?id=<id>

Paramètres

• id : identifiant unique correspondant au cursus

Réponse

{
  "data" : {
    "text" : "<texte formaté en HTML>",
    "md_text" : "<texte formaté en Markdown>"
  }
}

Recherche

Méthode

GET /api/1/search.json?q=<query>

Paramètres

• query : texte à rechercher. La recherche n’est actuellement disponible que pour les titres, elle ne fonctionne pas pour le texte des contenus. Les jokers de MySQL ne sont pas pris en compte (*, _ et %).

Réponse

{
  "data" : [
    {
      "title" : "<titre du résultat>",
      "href" : "<URL du résultat>"
    },
    …
  ]
}

Utilisateurs

Vérifier la disponibilité d’un nom d’utilisateur

Cette méthode permet uniquement de vérifier si un nom d’utilisateur est déjà pris ou non, elle ne vérifie pas si le nom d’utilisateur donné en paramètre est correct.

Méthode

GET /api/1/users/exists.json?username=<username>

Paramètres

• username : nom d’utilisateur à tester

Réponse

La réponse ne comporte qu’un booléen (true ou false) qui indique si le nom d’utilisateur donné est pris, par exemple :

{
  "data" : true
}