GET /friend/get-friends

version 2.0.0

Récupère les amitiés d'un joueur.

Authentification

Cette route nécessite de mettre votre clé API dans le Header.

👥 Autorisation

Les personnes autorisées pour utiliser cette requête sont :

Un seul paramètre est requis dans l'URL :

Nom	Type	Dans	Requis	Description
`playerId`	number	URL	✅	L’identifiant d'un des deux joueurs

Les données que l'API retournera avec le succès de la requête :

Nom	Type	Nullable	Description
`player1Id`	number	❌	L’identifiant d'un des deux joueurs
`player2Id`	number	❌	L’identifiant du deuxième joueur

Voici un exemple pour récupérer les amis d'un joueur :

http://0.0.0.0/api/friend/get-friends?playerId=2

Si des amitiés sont trouvés (code 200) :

[
    {
        "player1Id": 2,
        "player2Id": 1
    },
    {
        "player1Id": 2,
        "player2Id": 3
    }
]

info

Si aucune amitié n'est trouvé, l'API retourne un tableau vide.

Les différents types d'erreurs :

Code HTTP	Description	Cause possible
400	Bad Request	Paramètres manquants ou invalides
401	Unauthorized	Clé API manquante ou invalide
403	Forbidden	Droits insuffisants pour utiliser la requête
404	Not found	Entité introuvable
500	Internal Server Error	Erreur interne du serveur

Attention !

En cas d'erreur 500, contactez directement Zeltaria avec votre requête, sa réponse ainsi que toutes informations que vous jugez pertinentes !

En cas d'erreur voici les informations que retourne l'API

Nom	Type	Description
`code`	number	Le code d'erreur que retourne la requête
`message`	string	Le message de l'API expliquant l'erreur

Exemple avec l'erreur 403 Forbidden :

Ici par exemple, l'erreur 403 signifie que vous n'avez pas les droits pour cette requête.

{
    "message": "Access Denied",
    "code": 403
}