Générer un code PIN

1. Introduction

Avec MyQ REST API, vous pouvez générer un nouveau code PIN 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 code pin pour accéder à son compte. Ce point d'accès peut également être utilisé avec la fonction "Mot de passe oublié".

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 d'arrivée que nous utiliserons dans ce guide est défini comme suit :

CODE

Endpoint:
POST /users/{id}/pins

Authentication:
Grant_type: client_credentials
Scopes: [ users ]

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

Body: 
{
	"deleteOld": boolean
}

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.

Il ressort de la définition que celle-ci comprend un paramètre facultatif deleteOld dans le corps et un paramètre obligatoire dans le chemin d'accès 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.

deleteOld détermine si les anciens codes doivent être supprimés. Les utilisateurs de MyQ peuvent avoir plusieurs codes pin. La définition de ce paramètre à true (par défaut false) supprime les anciens codes pin.

4. Réponse

CODE

Code:
2xx

Response:
{
	"pin: 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 les nouvelles données générées. épingle.