« Documentation de l'API Onche.org » : différence entre les versions
user: e28f430 (?) Balises : Via portable Via portable |
(Wikifiage + mise en forme) |
||
| Ligne 1 : | Ligne 1 : | ||
{{Bannière Travaux}} | {{Bannière Travaux}} | ||
L''''API''' (''interface de programmation d'application'') du forum '''[[Onche.org]]''', est utilisée de manière analogue à l'[[Documentation de l'API Jeuxvideo.com|API de Jeuxvideo.com]], permettant d'interagir facilement avec le [[forum]] depuis une application, un site, ou n'importe quels autres programmes extérieurs. | |||
== Fonctionnement général du site == | == Fonctionnement général du site == | ||
Le site utilise | Le site utilise principalement 3 bibliothèques pour son fonctionnement.<ref name=":0">https://onche.org/js/license.txt</ref> | ||
* [https://jquery.com/ ''jQuery''] pour la majorité des appels à l'API.<ref name=":0" /> | |||
* [https://github.com/js-cookie/js-cookie ''JavaScript Cookie''] pour la gestion des cookies.<ref name=":0" /> | |||
* [https://fr.react.dev/ ''React''] pour la conception de l'interface utilisateur.<ref name=":0" /> | |||
L'inclusion simultanée de React et jQuery est une pratique peu commune. Cela s'avère problématique du fait des disparités de fonctionnement entre ces deux bibliothèques, pouvant engendrer une multitude de bugs, une baisse de performance notable et compliquer la mise en œuvre de nouvelles fonctionnalités, ainsi que la maintenance des fonctionnalités existantes.<ref>https://stackoverflow.com/a/51304632</ref> | |||
== API == | |||
== Endpoints == | === <u>Endpoints</u> === | ||
Il y a différents niveaux d'accès en fonction du status de l'utilisateur, le serveur évalue le niveau d'accès en fonction du cookie '''''auth'''''. | |||
==== <u>Disponibles pour tous les utilisateurs</u> ==== | |||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
| Ligne 31 : | Ligne 40 : | ||
|} | |} | ||
=== Réservés aux modos et aux admins === | ==== <u>Réservés aux modos et aux admins</u> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
| Ligne 75 : | Ligne 84 : | ||
|} | |} | ||
<references /> | |||
Version du 16 mars 2024 à 17:42
Cet article est en cours de rédaction ou de réécriture. La version que vous lisez n'est pas définitive et peut manquer d'informations importantes ou de sources.
L'API (interface de programmation d'application) du forum Onche.org, est utilisée de manière analogue à l'API de Jeuxvideo.com, permettant d'interagir facilement avec le forum depuis une application, un site, ou n'importe quels autres programmes extérieurs.
Fonctionnement général du site
Le site utilise principalement 3 bibliothèques pour son fonctionnement.[1]
- jQuery pour la majorité des appels à l'API.[1]
- JavaScript Cookie pour la gestion des cookies.[1]
- React pour la conception de l'interface utilisateur.[1]
L'inclusion simultanée de React et jQuery est une pratique peu commune. Cela s'avère problématique du fait des disparités de fonctionnement entre ces deux bibliothèques, pouvant engendrer une multitude de bugs, une baisse de performance notable et compliquer la mise en œuvre de nouvelles fonctionnalités, ainsi que la maintenance des fonctionnalités existantes.[2]
API
Endpoints
Il y a différents niveaux d'accès en fonction du status de l'utilisateur, le serveur évalue le niveau d'accès en fonction du cookie auth.
Disponibles pour tous les utilisateurs
| Description | URL | METHOD | BODY |
|---|---|---|---|
| JSON des stickers | stickers/favorites | GET | |
| notifications (forum + mp) JSON | notifications/count | GET | |
| liste utilisateurs online | user/logged | GET |
Réservés aux modos et aux admins
| Description | URL | METHOD | BODY |
|---|---|---|---|
| admin/unbanip | POST | ||
| admin/banip | POST | ||
| admin/unban | POST | ||
| admin/ban | POST | ||
| admin/jail | POST | ||
| admin/unjail | POST | ||
| message/remove/ | POST |