Méthodes d'authentification

Utilisations de l'API OAuth 2.0 par le biais de HTTPS.

1. Champ d'application

Le champ d'application vous permet de spécifier exactement le type d'accès dont vous avez besoin (liste séparée par des espaces). 

Pour pouvoir accéder à une ressource donnée (point final), une demande DOIT être accompagnée d'un jeton d'accès avec la portée nécessaire accordée. Toutes les portées ne doivent pas être accordées. Vérifiez toujours `scope` dans la réponse access_token.

Pour plus d'informations sur les champs d'application nécessaires pour un certain point d'accès, veuillez vous référer à la section Page des champs d'application.

Les champs d'application limitent l'accès aux jetons OAuth et n'accordent pas d'autres autorisations que celles que l'utilisateur a déjà définies dans MyQ.

2. Types de subventions supplémentaires

2.1. Connexion de l'utilisateur

Demander un jeton d'accès en fournissant un "login_info"avec un objet les informations d'identification de l'utilisateur.

Exemple de demande d'authentification

Endpoint:
POST /api/auth/token

Headers:
Content-Type:application/json

Body: 
{
	"grant_type": "login_info",
	"scope": "jobs offline.access",
	"client_id": "7B4CD3C2-F57E-4D52-A90A-23EED001CE81",
	"client_secret": "89fbf537fe689fca26f67abae7a557106f4348d5",
	"login_info": {
		"type": 2,
		"pin": "1234"
	}
}

Login Info grant permet de demander des jetons d'accès en fournissant les informations d'identification de l'utilisateur. Mot de passe octroi, cette demande doit avoir un "login_info"Cet objet permet de se connecter en utilisant l'une des options de connexion des utilisateurs valides. Cet objet permet de se connecter en utilisant l'une des options de connexion des utilisateurs valides. Voici quelques exemples d'objets d'informations de connexion pour chaque type de connexion :

2.1.1. Carte d'utilisateur

Propriétés obligatoires de l'objet LoginInfo

"login_info": {
	"type": 1,
	"card": "123456"
}

2.1.2. Broche de l'utilisateur

Propriétés obligatoires de l'objet LoginInfo

"login_info": {
	"type": 2,
	"pin": "1234"
}

2.1.3. Utilisateur et mot de passe

Propriétés obligatoires de l'objet LoginInfo

"login_info": {
	"type": 3,
	"user": "user",
	"pwd": "password"
}

2.1.4. Carte et broche

Propriétés obligatoires de l'objet LoginInfo

"login_info": {
	"type": 4,
	"card": "123456",
	"pin": "1234"
}

2.1.5. Carte et mot de passe

Propriétés obligatoires de l'objet LoginInfo

"login_info": {
	"type": 5,
	"card": "123456",
	"pwd": "password"
}

2.2. Connexion du client

Demander un jeton en utilisant informations d'identification du client.

Endpoint:
POst /api/auth/token

Headers:
Content-Type:application/json

Body: 
{
	"grant_type": "client_credentials",
	"scope": "jobs offline.access",
	"client_id": "7B4CD3C2-F57E-4D52-A90A-23EED001CE81",
	"client_secret": "89fbf537fe689fca26f67abae7a557106f4348d5",
}

3. Récupération d'un jeton d'accès

Point d'arrivée du jeton d'authentification : POST /api/auth/token

Si l'authentification se produit, vous recevrez un qui doit être fourni à tout autre point de terminaison de l'API.

Exemple de réponse

{
	"access_token": "your_bearer_token",
	"token_type": "Bearer",
	"expires_in": 1800,
	"scope": "jobs offline.access",
	"refresh_token": "your_refresh_token"
}