« Documentation de l'API Jeuxvideo.com » : différence entre les versions

(Documentation des derniers endpoints inconnus)
Ligne 101 : Ligne 101 :
=API v4=
=API v4=


==Utilisation ==
== Préambule ==
L'API v4 utilise une sécurité, l'en-tête HTTP <code>Jvc-Authorization</code> , sa valeur dépend d'une clé fixe <code>partner_key</code>, d'une <code>signature</code>  et de la <code>date</code> .
L'API v4 utilise une sécurité, l'en-tête HTTP <code>Jvc-Authorization</code> , sa valeur dépend d'une clé fixe <code>partner_key</code>, d'une <code>signature</code>  et de la <code>date</code> .


Ligne 144 : Ligne 144 :
</pre>
</pre>


===Connexion===
===Authentifiation===
Comme pour l'ancienne API, le cookie ''coniunctio'' est toujours le cookie de session utilisateur. Il doit être récupéré avec l'appel au point d'entrée ''accounts/login'' (voir tableau POST) puis il doit être envoyé dans une en-tête HTTP <code>"Cookie" : "coniunctio"</code> pour chaque appel.
Comme pour l'ancienne API, le cookie ''coniunctio'' est toujours le cookie de session utilisateur. Il doit être récupéré avec l'appel au point d'entrée ''accounts/login'' (voir tableau POST) puis il doit être envoyé dans une en-tête HTTP <code>"Cookie" : "coniunctio={coniunctio}"</code> pour chaque appel.




Ligne 164 : Ligne 164 :


*'''URL''': URL de l'endpoint
*'''URL''': URL de l'endpoint
*'''PARAMS''': variable entre accolades à remplacer dans l'URL, suivi de son type ''str'' ou ''int''.  
*'''PARAMS, HEADERS''':  
**<code>contents/{contentID}/comments</code> doit être appelé comme suivant <code>contents/someID1234/comments</code>
** '''params''' : variables entre accolades à remplacer dans l'URL, suivies de son type ''str'' ou ''int''. Par exemple, <code>contents/{contentID}/comments</code> doit être appelé comme suivant <code>contents/someID1234/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.).
 
*'''QUERY''': 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''': 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
Ligne 173 : Ligne 175 :
!NOM
!NOM
!URL
!URL
!PARAMS  
!PARAMS, HEADERS
!BODY
!BODY
|-
|-
Ligne 226 : Ligne 228 :
|register
|register
|accounts/register  
|accounts/register  
''le header doit inclure'' <code>"Jvc-Auth-Token" : str</code>
| '''header''' : <code>"Jvc-Auth-Token" : str</code>
|
|<pre>"email": "email",
|<pre>"email": "email",
"alias": "pseudo",
"alias": "pseudo",
Ligne 309 : Ligne 310 :
!NOM
!NOM
!URL
!URL
!PARAMS
!PARAMS, HEADERS
!QUERY  
!QUERY  
|-
|-
Ligne 685 : Ligne 686 :
!NOM
!NOM
!URL
!URL
!PARAMS
!PARAMS, HEADERS
!BODY
!BODY
|-
|-
Ligne 691 : Ligne 692 :
|accounts/me/profile/description  
|accounts/me/profile/description  
|
|
|''rétro-ingénierie à faire''
|"description": "Ma description"
|-
|-
|saveExcludedMachines
|saveExcludedMachines
Ligne 712 : Ligne 713 :
|uploadAvatar
|uploadAvatar
|accounts/me/avatar
|accounts/me/avatar
|
| '''header''' : <code>"Content-Type": "application/octet-stream"</code>
|''rétro-ingénierie à faire''
|objet <code>bytes</code> (conversion du fichier image en octets, pas de clé associée)
|-
|-
|uploadCover
|uploadCover
|accounts/me/cover
|accounts/me/cover
|
| '''header''' : <code>"Content-Type": "application/octet-stream"</code>
|''rétro-ingénierie à faire''
|objet <code>bytes</code> (conversion du fichier image en octets, pas de clé associée)
|}
|}
{| class="wikitable sortable"
{| class="wikitable sortable"
|+GET
|+DELETE
!NOM
!NOM
!URL
!URL
!PARAMS
!PARAMS, HEADERS
!BODY
|-
|-
|deleteComment
|deleteComment
Ligne 730 : Ligne 732 :
|'''contentID''' str
|'''contentID''' str
'''commentID''' str
'''commentID''' str
|
|-
|-
|deleteCommentVote
|deleteCommentVote
Ligne 735 : Ligne 738 :
|'''contentID''' str
|'''contentID''' str
'''commentID''' str
'''commentID''' str
|}
|
{| class="wikitable sortable"
|+CUSTOM HTTP (''rétro-ingénierie à faire'')
! NOM
!URL
!PARAMS
|-
|-
|deleteFavorisForum
|deleteFavorisForum
|accounts/{accountId}/favorites/forums  
|accounts/me/favorites/forums  
|'''accountId''' str
|
|'''forums''' list // ID des forums
|-
|-
| deleteFavorisGames
| deleteFavorisGames
|accounts/{accountId}/favorites/games
|accounts/me/favorites/games
|'''accountId''' str
|
|'''games''' <code>[{"id":"ID du jeu", "machine":"ID de la machine"}]</code>
|-
|-
|deleteFavorisTopics
|deleteFavorisTopics
|accounts/{accountId}/favorites/topics
|accounts/me/favorites/topics
|'''accountId''' str
|
|'''topics''' list // ID des topics
|}
|}