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

Avatar de MetaModelling MetaModelling Posté le 23/12/2017 à 18:08:20
Citation de Factom
Citation de MetaModelling
Moyen de supprimer un message depuis l'API?
Créer/supprimer un topic?
Pas encore, faudra attendre la V2 pour ça :( ni d'éditer des messages

Dommage, pas moyen de faire un vrai client dans le shell sans ça...

Si il faut un coup de main pour développer l'API, j'ai des compétences.
Avatar de MetaModelling MetaModelling Posté le 27/12/2017 à 17:05:45
Citation de Factom
Citation de MetaModelling
:up:
Quelqu'un peut me dire si les devs bossent dessus?
Ence avait dit que ça serait pour 2018
Si tu veux absolument un client en attendant : https://github.com/Modaf/[...]oel/blob/master/client.py
Apercite https://github.com/Modaf/Client-python-de-avenoel/blob/master/client.py


J'ai fais un client de mon coté aussi. :hap:

J'aimerai faire un bot pour faire des risitas interactifs de façon +/- automatique (avec des events random selon les actions choisies par les participants au topic). En gros, un genre de génération procédurale (https://fr.wikipedia.org/[...]A9ration_proc%C3%A9durale
Apercite https://fr.wikipedia.org/wiki/G%C3%A9n%C3%A9ration_proc%C3%A9durale
) de risitas.
Avatar de Zardoz Zardoz Posté le 07/02/2018 à 22:15:09
Je rencontre des problèmes sur

GET /topics/:id
GET /messages/:id
-----
https://avenoel.org/api/v1/topics?:104028
Apercite https://avenoel.org/api/v1/topics?:104028

de même que
https://avenoel.org/api/v1/topics?id=104028
Apercite https://avenoel.org/api/v1/topics?id=104028


retourne la liste complète des topics, pas seulement celui demandé
-----
https://avenoel.org/api/v1/messages?:1657348
Apercite https://avenoel.org/api/v1/messages?:1657348

de même que
https://avenoel.org/api/v1/messages?id=1657348
Apercite https://avenoel.org/api/v1/messages?id=1657348


retourne {"error":"Le champ topic id est obligatoire."}
-----
J'ai donc essayé
https://avenoel.org/api/v[...]57348&topid_id=104028
Apercite https://avenoel.org/api/v1/messages?id=1657348&topid_id=104028

avec le même résultat navrant.



Pas de problème sur GET /topics et GET /messages qui donnent les résultats escomptés.
#1774306
Avatar de Encendre Encendre Posté le 07/02/2018 à 23:51:11
Citation de Zardoz
Je rencontre des problèmes sur
GET /topics/:id
GET /messages/:id
-----
https://avenoel.org/api/v1/topics?:104028
Apercite https://avenoel.org/api/v1/topics?:104028

de même que
https://avenoel.org/api/v1/topics?id=104028
Apercite https://avenoel.org/api/v1/topics?id=104028

retourne la liste complète des topics, pas seulement celui demandé

https://avenoel.org/api/v1/topics/104028
Apercite https://avenoel.org/api/v1/topics/104028


https://avenoel.org/api/v1/messages?:1657348
Apercite https://avenoel.org/api/v1/messages?:1657348

de même que
https://avenoel.org/api/v1/messages?id=1657348
Apercite https://avenoel.org/api/v1/messages?id=1657348

retourne {"error":"Le champ topic id est obligatoire."}

https://avenoel.org/api/v1/messages/1657348
Apercite https://avenoel.org/api/v1/messages/1657348

Avatar de JadaStevens JadaStevens Posté le 08/02/2018 à 20:49:28
Citation de Dev
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.

M'ouais.
Avatar de Zardoz Zardoz Posté le 09/02/2018 à 15:48:04
Citation de Factom
Dit l'erreur

Pardon pour l'erreur sur l'auteur du git. Je m'y paume.

Il me semble que GET messages?topic_id retourne un champ 'messages' et non 'data' (ligne 94) contrairement à GET messages/message_id.
#1797268
Liste des sujets