Modification de Documentation de l'API Jeuxvideo.com
La modification peut être annulée. Veuillez vérifier les différences ci-dessous pour voir si c’est bien ce que vous voulez faire, puis publier ces changements pour finaliser l’annulation de cette modification.
Version actuelle | Votre texte | ||
Ligne 108 : | Ligne 108 : | ||
Vous pouvez désormais voir quelles requêtes sont passées à l'API, ainsi que les ''headers'' et ''body'' associés. Par exemple lorsque l'on se connecte : | Vous pouvez désormais voir quelles requêtes sont passées à l'API, ainsi que les ''headers'' et ''body'' associés. Par exemple lorsque l'on se connecte : | ||
[[File:http_toolkit.png| | [[File:http_toolkit.png|400px]] | ||
=API v4= | =API v4= | ||
Ligne 145 : | Ligne 145 : | ||
'''URL de base''': ''<nowiki>https://api.jeuxvideo.com/v4/</nowiki>'' | '''URL de base''': ''<nowiki>https://api.jeuxvideo.com/v4/</nowiki>'' | ||
*''' | *'''URL''': URL de l'endpoint | ||
*'''PARAMS, HEADERS''': | *'''PARAMS, HEADERS''': | ||
** '''param''' : variable entre accolades à remplacer dans l'URL, suivie dans la documentation de son type (''str'' ou ''int''). Par exemple, <code>contents/{contentID}/comments</code> doit être appelé comme suit : <code>contents/123456/comments</code>. <br> Note : dans la plupart des cas, le paramètre <code>accountId</code> peut être remplacé par la valeur <code>me</code> lorsque la requête doit pointer sur le compte connecté. | ** '''param''' : variable entre accolades à remplacer dans l'URL, suivie dans la documentation de son type (''str'' ou ''int''). Par exemple, <code>contents/{contentID}/comments</code> doit être appelé comme suit : <code>contents/123456/comments</code>. <br> Note : dans la plupart des cas, le paramètre <code>accountId</code> peut être remplacé par la valeur <code>me</code> lorsque la requête doit pointer sur le compte connecté. | ||
Ligne 156 : | Ligne 156 : | ||
|+POST | |+POST | ||
!NOM | !NOM | ||
! | !URL | ||
!PARAMS, HEADERS | !PARAMS, HEADERS | ||
!BODY | !BODY | ||
Ligne 311 : | Ligne 311 : | ||
|+GET | |+GET | ||
!NOM | !NOM | ||
! | !URL | ||
!PARAMS, HEADERS | !PARAMS, HEADERS | ||
!QUERY | !QUERY | ||
Ligne 665 : | Ligne 665 : | ||
|+PUT | |+PUT | ||
!NOM | !NOM | ||
! | !URL | ||
!PARAMS, HEADERS | !PARAMS, HEADERS | ||
!BODY | !BODY | ||
Ligne 704 : | Ligne 704 : | ||
|+DELETE | |+DELETE | ||
!NOM | !NOM | ||
! | !URL | ||
!PARAMS, HEADERS | !PARAMS, HEADERS | ||
!BODY | !BODY | ||
Ligne 957 : | Ligne 957 : | ||
Le tableau suivant répertorie les ''endpoints'' connus de cette API. Voici la signification de ses colonnes : | Le tableau suivant répertorie les ''endpoints'' connus de cette API. Voici la signification de ses colonnes : | ||
*'''PATH''' : chemin de l'''endpoint''. | *'''PATH''': chemin de l'''endpoint''. | ||
*'''PARAMS, HEADERS''' : | *'''PARAMS, HEADERS''': | ||
** '''param''' : variable entre accolades à remplacer dans l'URL, suivie dans la documentation de son type (''str'' ou ''int''). Par exemple, <code>contents/{contentID}/comments</code> doit être appelé comme suit : <code>contents/123456/comments</code>. | ** '''param''' : variable entre accolades à remplacer dans l'URL, suivie dans la documentation de son type (''str'' ou ''int''). Par exemple, <code>contents/{contentID}/comments</code> doit être appelé comme suit : <code>contents/123456/comments</code>. | ||
** '''header''' : ''header'' particulier à inclure dans l'en-tête de la requête. Si pas de spécification, l'en-tête ne contient que les ''headers'' de base spécifiés plus haut (''User-Agent'', ''Jvc-Authorization'', etc.). | ** '''header''' : ''header'' particulier à inclure dans l'en-tête de la requête. Si pas de spécification, l'en-tête ne contient que les ''headers'' de base spécifiés plus haut (''User-Agent'', ''Jvc-Authorization'', etc.). | ||
*'''QUERY''' : valeur à ajouter à l'URL permettant si précisée de filtrer les résultats. Par exemple pour les deux query ''page'', ''perPage'' int, l'URL devra être: <code>api.jeuxvideo.com/v4/contents/1234ID/comments?page=1&perPage=30</code> | *'''QUERY''': valeur à ajouter à l'URL permettant si précisée de filtrer les résultats. Par exemple pour les deux query ''page'', ''perPage'' int, l'URL devra être: <code>api.jeuxvideo.com/v4/contents/1234ID/comments?page=1&perPage=30</code> | ||
*'''BODY''' : Corps de la requête au format JSON | *'''BODY''': Corps de la requête au format JSON | ||
=== Les paramètres spéciaux === | === Les paramètres spéciaux === | ||
Ligne 1 005 : | Ligne 1 005 : | ||
Les ''queries'' renseignent le type des vidéos ainsi que la plateforme, le genre et l'événement des jeux traités. La liste complète des valeurs des ''queries'' possibles pour ces attributs est disponible au format JSON [https://pastebin.com/nBUAP4XX ici]. | Les ''queries'' renseignent le type des vidéos ainsi que la plateforme, le genre et l'événement des jeux traités. La liste complète des valeurs des ''queries'' possibles pour ces attributs est disponible au format JSON [https://pastebin.com/nBUAP4XX ici]. | ||
Par exemple, si vous souhaitez obtenir la liste des vidéos ''gameplays'' des jeux PC de genre Action en rapport avec l'événement E3, votre | Par exemple, si vous souhaitez obtenir la liste des vidéos ''gameplays'' des jeux PC de genre Action en rapport avec l'événement E3, votre chaînde ''queries'' devra être <code>publicationType=gameplay&platform=pc&gameGenre=action&event=e3</code>. | ||
=== Queries globaux === | === Queries globaux === | ||
Ce sont les ''queries'' ''offset'' et ''limit'', de type ''int'', qui représentent respectivement l'indice de l'item dans la liste à partir duquel les items sont listés (par défaut 0) et le nombre d'items à lister (par défaut 100). Ils fonctionnent avec toutes les recherches. | Ce sont les ''queries'' ''offset'' et ''limit'', de type ''int'', qui représentent respectivement l'indice de l'item dans la liste à partir duquel les items sont listés (par défaut 0) et le nombre d'items à lister (par défaut 100). Ils fonctionnent avec toutes les recherches. | ||
=== Liste des endpoints connus === | === Liste des endpoints connus === | ||
Ligne 1 047 : | Ligne 1 037 : | ||
'''limit''' int <br> | '''limit''' int <br> | ||
'''release''' str | '''release''' str | ||
|Renvoie la liste des jeux | |Renvoie la liste des jeux tendances triés par note décroissante des rédacteurs JVC et satisfaisant les ''queries''. | ||
|- | |- | ||
|games/{gameCategory}/releaseDate.asc | |games/{gameCategory}/releaseDate.asc | ||
Ligne 1 057 : | Ligne 1 047 : | ||
'''limit''' int <br> | '''limit''' int <br> | ||
'''release''' str | '''release''' str | ||
|Renvoie la liste des jeux | |Renvoie la liste des jeux attendus triés par date de sortie croissante et satisfaisant les ''queries''. | ||
|- | |- | ||
|games/{gameCategory}/title.asc | |games/{gameCategory}/title.asc | ||
Ligne 1 067 : | Ligne 1 057 : | ||
'''limit''' int <br> | '''limit''' int <br> | ||
'''release''' str | '''release''' str | ||
|Renvoie la liste des jeux | |Renvoie la liste des jeux attendus triés par titre croissant et satisfaisant les ''queries''. | ||
|- | |- | ||
|news/datePublished.desc | |news/datePublished.desc | ||
Ligne 1 124 : | Ligne 1 114 : | ||
'''limit''' int | '''limit''' int | ||
|Renvoie la liste des annonces triées par date de publication croissante et satisfaisant les ''queries''. | |Renvoie la liste des annonces triées par date de publication croissante et satisfaisant les ''queries''. | ||
|- | |||
|topics/datePublished.desc | |||
| | |||
| '''offset''' int <br> | |||
'''limit''' int | |||
|Renvoie la liste des articles triés par date de publication croissante et satisfaisant les ''queries''. | |||
|- | |- | ||
|videos/datePublished.desc | |videos/datePublished.desc | ||
Ligne 1 134 : | Ligne 1 130 : | ||
'''limit''' int | '''limit''' int | ||
|Renvoie la liste des vidéos triées par date de publication croissante et satisfaisant les ''queries''. | |Renvoie la liste des vidéos triées par date de publication croissante et satisfaisant les ''queries''. | ||
|- | |- | ||
|me/{accessToken}/privateMessages | |me/{accessToken}/privateMessages |