Créer un utilisateur

1. Introduction

Des profils d'utilisateurs peuvent être créés via l'API. Cet utilisateur peut être utilisé dans le cadre d'un fonctionnement normal comme tout autre utilisateur créé manuellement. Cette méthode est généralement utilisée lorsqu'une application crée un utilisateur à distance. Il s'agit généralement d'un terminal distant, d'un terminal de recharge ou de toute autre application personnalisée.

2. Conditions préalables

L'application REST API dans MyQ → Settings → External Systems doit avoir accès à champ d'application appelés Utilisateurs.

3. Appeler l'API

Le point final est défini comme suit :

CODE

Endpoint:
POST /users

Authentication:
Grant_type: client_credentials
Scopes: [ users ]

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Body: 
{
	"username": "string",
	"fullname": "string"
}

Il convient de noter que le %access_token% doit être remplacé par le jeton que vous avez reçu en réponse à la commande point de terminaison d'authentification.

D'après la définition, nous pouvons voir que nom d'utilisateur et nom complet sont les seuls paramètres requis. De nombreux autres paramètres peuvent être définis. Ils peuvent être trouvés sur la page Page du point final dans le cadre de la /v3/utilisateurs point final.

4. Réponse

CODE

Code:
2xx

Response:
{
	"id": 0,
	"username": "string",
	"fullname": "string"
}

Si le point d'accès a été appelé correctement avec les bons paramètres. Le code de réponse devrait être 2xx et le corps devrait inclure un JSON avec le code id d'un utilisateur créé. Ce numéro doit être enregistré localement et peut être utilisé dans d'autres points d'accès pour modifier ou générer un code PIN pour cet utilisateur. Si le code d'état est 4xx, l'utilisateur existe probablement déjà ou il y a un autre problème. Voir Messages d'erreur page.