POST /inscription

version 2.0.0

Inscrire un nouvel utilisateur de l’API.

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
• Zeltaria

🧾 Paramètres

Les données doivent être envoyées dans le corps de la requête :

Nom	Type	Dans	Requis	Description	Valeur par default
username	string	Body	✅	Le nom d’utilisateur à inscrire	❌
role	string	Body	❌	Le role à attribuer à l'utilisateur	USER

🧾 Réponse

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

Nom	Type	Nullable	Description
username	string	❌	Le nom d’utilisateur à inscrire
role	string	❌	Le role à attribuer à l'utilisateur
apiKey	string	❌	La clé API de l'utilisateur à lui transmettre

📤 Exemple de requête

Voici un exemple de requête pour inscrire un utilisateur :

http://0.0.0.0/api/inscription

Et dans le body :

    {
        "username": "MonNouvelUtilisateur",
        "role": "USER"
    }

📥 Exemple de réponse

En cas de réussite, le code HTTP sera le 201 Created. Il retourne aussi les informations de l'utilisateur créé :

{
    "username" : "MonNouvelUtilisateur",
    "role" : "USER",
    "apiKey" : "8598f1bb-7115-4e43-8f2c-5cb819074589"
}

⛔ 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 du nouvel utilisateur. Dans notre cas, l'username est déjà utilisé par quelqu'un d'autre.

{
    "code": 409,
    "message": "Duplicate entry 'Zeltaria' for key 'username'"
}