Retour au sujet

Avatar de Dev Dev Posté le 12/11/2017 à 22:13:10
Documentation de l'API :

L'API d'Avenoel n'est pas encore complète, elle sera mise à jour régulièrement ainsi que sa documentation.
URL de base : https://avenoel.org/api/v1/
Apercite https://avenoel.org/api/v1/


Format de la documentation :

VERB /path
required_param : description (type)
not_required_param : description (type)
Description

Partie accessible sans connexion

GET /topics
start : nombre de topics à passer (i.e. pour passer les 3 premiers topics mettre 3) (int, default: 0)
size : nombre de topics à récupérer (int, default: 20)
reverse : récupère les derniers topics en premier (bool, default: false)
with_user : récupère les informations sur les utilisateurs (bool, default: false)
Récupère la liste des topics.

GET /topics/:id
id : id du topic (int)
with_user : récupère les informations sur les utilisateurs (bool, default: false)
Récupère les informations d'un topic.

GET /messages
topid_id : id du topic (int)
min_id : récupère les messages avec un id supérieur à min_id (int, default : 0)
start : nombre de messages à passer (int, default: 0)
size : nombre de messages à récupérer (int, default: 20)
reverse : récupère les derniers messages en premier (bool, default: false)
with_topic : récupère les informations sur le topic (bool, default: false)
with_user : récupère les informations sur les utilisateurs (bool, default: false)
Récupère la liste des messages d'un topic.

GET /messages/:id
id : id du message (int)
with_topic : récupère les informations sur le topic (bool, default: false)
with_user : récupère les informations sur l'utilisateur (bool, default: false)
Récupère les informations d'un message.

GET /user/:id
id : id de l'utilisateur (int)
Récupère les informations d'un utilisateur.

Partie accessible uniquement avec connexion

Pour se connecter à l'API il faut récupérer un token puis le mettre dans un header X-Authorization.

Par exemple pour récupérer les informations sur sa session avec un token on peut faire :

curl https://avenoel.org/api/v1/auth
Apercite https://avenoel.org/api/v1/auth
-H "X-Authorization:e21d2a5c49bde8a3be71a14cc40bdfdb88bc7177"

POST /auth
username : nom de l'utilisateur (string)
password : mot de passe de l'utilisateur (string)
S'identifie à l'API.

POST /messages
topic_id : id du topic (int)
content : contenu du message (string)
Poste un message dans un topic.

PUT /messages/:id
id : id du message (int)
content : contenu à modifier (string)
Modifie le contenu d'un message.
#523719