POST /friend/add-friend

version 2.0.0

Créer une belle amitié.

Authentification

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

👥 Autorisation

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

• Corail
• Zelta

🧾 Paramètres

Les champs suivants sont attendus dans le corps de la requête :

Nom	Type	Dans	Requis	Description	Valeur par default
player1Id	number	URL	✅	L’identifiant d'un des deux joueur	❌
player2Id	number	URL	✅	L’identifiant du deuxième joueur	❌

🧾 Réponse

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 joueur
player2Id	number	❌	L’identifiant du deuxième joueur

📤 Exemple de requête

Voici un exemple d’appel à cette route :

http://0.0.0.0/api/friend/add-friend

Et dans le body mettre par exemple :

{
    "player1Id": 2,
    "player2Id": 3
}

📥 Exemple de réponse

Si l’amitié a bien été créé (code 201) :

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

⛔ Les erreurs

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
409	Conflict	Conflit avec des données existantes
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 409 Conflict :

Ici par exemple, l'erreur 409 signifie que la base de donnée a rencontré une erreur lors de l'ajout d'une nouvelle amitié. Dans notre cas, l'id 2 et 3 sont déjà amie.

{
    "message": "could not execute statement [(conn=10044933) Duplicate entry '2-3' for key 'PRIMARY'] [insert into friends (player1_id,player2_id) values (?,?)]; SQL [insert into friends (player1_id,player2_id) values (?,?)]; constraint [PRIMARY]",
    "code": 409
}