Kheys
423
modifications
« Documentation de l'API Jeuxvideo.com » : différence entre les versions
m
Div anchor sur JVClient
(Ajout du modèle ''Article de la qualité'' suite à la promotion de l'article dans la catégorie citée) |
m (Div anchor sur JVClient) |
||
| (7 versions intermédiaires par 3 utilisateurs non affichées) | |||
| Ligne 1 : | Ligne 1 : | ||
{{Bannière Info|Contenu=Cette page documente l'API v4 de jeuxvideo.com. Le fonctionnement du site est quant à lui détaillé sur [[Fonctionnement technique de Jeuxvideo.com]].}} | |||
L''''API de [[jeuxvideo.com]]''', utilisée à l'origine par les applications mobiles de jeuxvideo.com, permet de développer plus facilement des applications, sites Web, et autres scripts en rapport avec jeuxvideo.com. | L''''API de [[jeuxvideo.com]]''', utilisée à l'origine par les applications mobiles de jeuxvideo.com, permet de développer plus facilement des applications, sites Web, et autres scripts en rapport avec jeuxvideo.com. | ||
| Ligne 6 : | Ligne 8 : | ||
Les anciennes versions sont toujours exploitables avec les ''tokens'' qui leur sont propres{{Commentaire|Autre=potentiellement obsolète}}, mais certains ''endpoints'' renvoient des erreurs HTTP 403. | Les anciennes versions sont toujours exploitables avec les ''tokens'' qui leur sont propres{{Commentaire|Autre=potentiellement obsolète}}, mais certains ''endpoints'' renvoient des erreurs HTTP 403. | ||
<div id="jvclient"></div> | |||
=JVClient= | |||
[[File:icon-512x512.png|vignette|256px|Le logo de JVClient : « Le pouvoir par les données ».]] | |||
[https://www.npmjs.com/package/jv-client '''JVClient'''] est une '''librairie Node.js''' écrite en TypeScript qui fournit des classes et des fonctions permettant d'interagir avec l'API v4 de jeuxvideo.com ainsi que le site JVC lui-même. | |||
Publiée en février 2025, son objectif est de servir de base aux programmeurs pour le ''scraping'' de données sur des jeux, articles, forums, topics, etc. et pour l'exécution d'opérations nécessitant un compte connecté (comme poster des topics). Le code est ''open source'' et disponible sur Github<ref>https://github.com/Contrapunctus-XIV/jv-client</ref>. | |||
Elle dispose également d'une documentation complète<ref>https://contrapunctus-xiv.github.io/jv-client/</ref> qui explique en détail l'organisation des données de jeuxvideo.com. | |||
{{clear}} | |||
=Rétro-ingénierie de l'application mobile JVC= | =Rétro-ingénierie de l'application mobile JVC= | ||
| Ligne 82 : | Ligne 95 : | ||
Il s'avère que ''Jvc-Auth-Header'' contient le [https://stackoverflow.com/questions/37671380/what-is-fcm-token-in-firebase token FCM], un token créé par la plateforme ''FireBase'' de Google et utilisé par l'application mobile pour accéder aux bases de données. Ce token est unique à chaque appareil et est créé à chaque installation de l'application mobile. En outre, il permet à l'API de savoir si l'application a déjà effectué une requête d'inscription dans les dernières 24 heures et, le cas échéant, de bloquer les requêtes d'inscription. | Il s'avère que ''Jvc-Auth-Header'' contient le [https://stackoverflow.com/questions/37671380/what-is-fcm-token-in-firebase token FCM], un token créé par la plateforme ''FireBase'' de Google et utilisé par l'application mobile pour accéder aux bases de données. Ce token est unique à chaque appareil et est créé à chaque installation de l'application mobile. En outre, il permet à l'API de savoir si l'application a déjà effectué une requête d'inscription dans les dernières 24 heures et, le cas échéant, de bloquer les requêtes d'inscription. | ||
Il semble malheureusement impossible de générer de tels tokens « à la demande », en tout cas sans connaître les noms et clés des services FireBase dédiés à l'application. | Il semble malheureusement impossible de générer de tels tokens « à la demande », en tout cas sans connaître les noms et clés des services FireBase dédiés à l'application. Une alternative "temporaire" consisterait à spawner des Android virtualisés, d'y installer de façon automatisée l'APK de JVC, puis de créer des comptes. Mais dans ce type de contexte, ce n'est plus vraiment de la rétro-ingiénierie. | ||
<div id="interception"></div> | <div id="interception"></div> | ||
| Ligne 131 : | Ligne 144 : | ||
<div id="sous-domaine"></div> | <div id="sous-domaine"></div> | ||
== Comportement du sous-domaine == | == Comportement du sous-domaine pour les forums == | ||
Il est intéressant de remarquer que l'API se comporte souvent en véritable | Il est intéressant de remarquer que l'API se comporte souvent en véritable site Web, qui réplique les forums du site www.jeuxvideo.com : par exemple, si vous êtes sur un [[topic]] ou un [[forum]], il vous suffit de remplacer dans l'URL « www » par « api » et vous vous trouverez sur une page aux informations identiques quoique présentées de manière différente. Ainsi, les URL seront de la forme <code>https://api.jeuxvideo.com/forums/0-51-0-1-0-1-0-blabla-18-25-ans.htm</code>. Il manque cependant de nombreuses fonctionnalités comme les pages de profils sur le sous-domaine API. | ||
[[File:forum_api.png|vignette|350px|Le forum [[Blabla 18-25 ans]] sur le site de l'API.]] | [[File:forum_api.png|vignette|350px|Le forum [[Blabla 18-25 ans]] sur le site de l'API.]] | ||
| Ligne 140 : | Ligne 153 : | ||
{{clear}} | {{clear}} | ||
==Endpoints | ==Endpoints de service== | ||
Il s'agit des ''endpoints'' « documentés » dans le code de l'application mobile et qui se comportent différemment des services de l'API qui ne se contentent que de « copier » le contenu JVC (voir sous-section précédente). | Il s'agit des ''endpoints'' « documentés » dans le code de l'application mobile et qui se comportent différemment des services de l'API qui ne se contentent que de « copier » le contenu JVC (voir sous-section précédente). | ||
On rappelle que l'accès à ces ''endpoints'' nécessite un token d'authentification à fournir dans le header ''Jvc-Authorization''. Voir l'[[#annexe|annexe]] pour le générer. | |||
'''URL de base''': ''<nowiki>https://api.jeuxvideo.com/v4/</nowiki>'' | '''URL de base''': ''<nowiki>https://api.jeuxvideo.com/v4/</nowiki>'' | ||
| Ligne 683 : | Ligne 697 : | ||
| | | | ||
|<pre>"machines" : [1, 2, 3, 4] // id des machines</pre> | |<pre>"machines" : [1, 2, 3, 4] // id des machines</pre> | ||
|- | |||
|setFavorisForum | |||
|accounts/me/favorites/forums | |||
| | |||
|<code>"forums" : [50,51,52] # ID des forums</code> | |||
|- | |||
|setFavorisGames | |||
|accounts/me/favorites/games | |||
| | |||
|<code>"games" : [{"id":"ID du jeu", "machine":"ID de la machine"}]</code> | |||
|- | |||
|setFavorisTopics | |||
|accounts/me/favorites/topics | |||
| | |||
|<code>"topics" : [74229153, 74229154] # ID des topics</code> | |||
|- | |- | ||
|updateComment | |updateComment | ||
| Ligne 728 : | Ligne 757 : | ||
|accounts/me/favorites/games | |accounts/me/favorites/games | ||
| | | | ||
|<code>" | |<code>"games" : [{"id":"ID du jeu", "machine":"ID de la machine"}]</code> | ||
|- | |- | ||
|deleteFavorisTopics | |deleteFavorisTopics | ||
| Ligne 754 : | Ligne 783 : | ||
parsed_url = urllib.parse.urlparse(f"https://{DOMAIN}/v{API_VERSION}/{path}") | parsed_url = urllib.parse.urlparse(f"https://{DOMAIN}/v{API_VERSION}/{path}") | ||
if query: | if query: | ||
parsed_url = parsed_url._replace(query=urllib.parse.urlencode( | sorted_query = dict(sorted(query.items())) | ||
parsed_url = parsed_url._replace(query=urllib.parse.urlencode(sorted_query)) | |||
# Création de la chaîne à hash | # Création de la chaîne à hash | ||
| Ligne 926 : | Ligne 956 : | ||
*[https://pastebin.com/LWNDQDKy Classe PHP] exploitant l'API (cette classe est incomplète et sera possiblement rendue obsolète dans le temps). | *[https://pastebin.com/LWNDQDKy Classe PHP] exploitant l'API (cette classe est incomplète et sera possiblement rendue obsolète dans le temps). | ||
= API jvc.gg = | = API jvc.gg (dépréciée) = | ||
{{Bannière Note|Contenu=Le contenu qui va suivre concerne l'ancienne API qui n'existe plus.}} | |||
[[File:phoenix.png|300px|vignette|La page Phoenix des jeux.]] | [[File:phoenix.png|300px|vignette|La page Phoenix des jeux.]] | ||
Cette API | Cette API était une API distincte de la ''v4'' et utilisée par la partie Phoenix du site, c'est-à-dire les pages listant les jeux, ''reviews'', vidéos, etc., comme [https://www.jeuxvideo.com/tous-les-jeux/ celle-ci]. Elle était hébergée sur le domaine [https://api.jvc.gg api.jvc.gg]. | ||
L'API est fermée début février 2025 à la suite de la refonte des pages Phoenix de JVC qui adoptent désormais le même fonctionnement que les autres pages du site. | |||
{{clear}} | {{clear}} | ||
| Ligne 990 : | Ligne 1 024 : | ||
=== Queries des tests === | === Queries des tests === | ||
Les ''queries'' renseignent la plateforme, le mode et le genre des jeux testés, ainsi que l'encadrement de la note des rédacteurs et la date de publication. La liste complète des valeurs des ''queries'' possibles pour ces attributs est disponible au format JSON [https://pastebin.com/ | Les ''queries'' renseignent la plateforme, le mode et le genre des jeux testés, ainsi que l'encadrement de la note des rédacteurs et la date de publication. La liste complète des valeurs des ''queries'' possibles pour ces attributs est disponible au format JSON [https://pastebin.com/YxKif1DJ ici]. | ||
Par exemple, si vous souhaitez obtenir la liste des tests de jeux PC de genre aventure, de mode solo ayant eu au moins 14 et datant d'il y a au plus 6 mois, votre chaîne de ''queries'' devra être | Par exemple, si vous souhaitez obtenir la liste des tests de jeux PC de genre aventure, de mode solo ayant eu au moins 14 et datant d'il y a au plus 6 mois, votre chaîne de ''queries'' devra être | ||