Enregistrer la carte d'identité
1. Introduction
Avec MyQ REST API, vous pouvez générer un nouveau numéro de carte pour un utilisateur qui peut ensuite être utilisé pour se connecter à votre application personnalisée ou au système MyQ. Cela se fait généralement lorsque l'utilisateur s'enregistre dans le système et qu'il a besoin d'un numéro de carte pour accéder à son compte.
2. Les 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 d'arrivée que nous utiliserons dans ce guide est défini comme suit :
Endpoint:
POST /users/{id}/cards
Authentication:
Grant_type: client_credentials
Scopes: [ users ]
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%
Body:
{}
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.
dans le corps et un paramètre obligatoire dans le chemin d'accès au point final appelé {id}
.
Il s'agit de l'identifiant d'un utilisateur de MyQ. Cet identifiant peut être demandé de plusieurs façons au serveur MyQ. Nous montrerons comment procéder dans le guide Recherche d'un identifiant.
4. Réponse
Code:
2xx
Response:
{
"card": 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 nouveau fichier carte
.