Topic : « [API] Documentation de l'API d'Avenoel »

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.
Avatar de TuSaisKi TuSaisKi Posté le 12/11/2017 à 22:13:28
Bizn
Avatar de Neytiri Neytiri Posté le 12/11/2017 à 22:13:48
First

EDIT: Putain de 502 https://image.noelshack.com/fichiers/2017/01/1483903109-bloggif-5872903951574.gif
#523762
Avatar de Trisomique Trisomique Posté le 12/11/2017 à 22:14:09
first page sait-on jamais
Avatar de -Azeo -Azeo Posté le 12/11/2017 à 22:14:12
https://image.noelshack.com/fichiers/2017/43/7/1509270103-yoko5.png
Avatar de Yuwen Yuwen Posté le 12/11/2017 à 22:14:13
First page
Avatar de LloydIrving LloydIrving Posté le 12/11/2017 à 22:14:35
Akoa çasser https://image.noelshack.com/fichiers/2016/52/1483033505-risitaswtf.png
Avatar de Dyosir Dyosir Posté le 12/11/2017 à 22:14:52
J'y fus. :noel:
Avatar de scientifique scientifique Posté le 12/11/2017 à 22:15:07
On m'explique les jean-info ? https://image.noelshack.com/fichiers/2016/48/1480464158-1474824966-1474551493-1474308964-1473610653-picsart-09-11-06-13-46.png
Avatar de Ryo Ryo Posté le 12/11/2017 à 22:15:13
https://image.noelshack.com/fichiers/2016/48/1480464158-1474824966-1474551493-1474308964-1473610653-picsart-09-11-06-13-46.png
Avatar de Jaguar Jaguar Posté le 12/11/2017 à 22:15:16
C'est quoi un API ? nofake je voudrais vraiment savoir https://image.noelshack.com/fichiers/2016/48/1480464158-1474824966-1474551493-1474308964-1473610653-picsart-09-11-06-13-46.png
Avatar de Ugly Ugly Posté le 12/11/2017 à 22:15:26
https://image.noelshack.com/fichiers/2017/12/1490182124-larrychance.png
Avatar de BenShapiro BenShapiro Posté le 12/11/2017 à 22:15:27
Faites moi plaisir mes khey et faites une page sous forme de terminal où l'on peut interagir avec le site par des commandes. Genre pour trouver un topic et tout, mais sous forme de terminal style UNIX. C'est complètement inutile mais ce serait tellement génial :bave:
Avatar de JeanGabin JeanGabin Posté le 12/11/2017 à 22:15:38
First page https://image.noelshack.com/fichiers/2016/47/1480064732-1467335935-jesus4.png
Avatar de TuSaisKi TuSaisKi Posté le 12/11/2017 à 22:15:53
Dès que j'ai un vrai ordi à moi je m'y pencherai https://image.noelshack.com/fichiers/2017/04/1485268586-hackeur-v1.png
Avatar de RoyalMorangis2 RoyalMorangis2 Posté le 12/11/2017 à 22:16:19
ok cool je me met sur un RespawnIRC like sur PC en C#
Avatar de Discountizer Discountizer Posté le 12/11/2017 à 22:16:40
On peut l'utiliser sur AndroidSutdio ?
Je suis pret à me chauffer si je sais comment
Liste des sujets