Démarrer avec l'API REST
Dans ce guide, vous apprendrez à créer une application REST API dans MyQ Web UI et à utiliser les informations d'identification générées pour obtenir un jeton d'authentification du serveur. Vous devriez avoir déjà installé MyQ Print Server. Guide d'installation.
1. Bonjour le monde
Commençons par vérifier si notre serveur d'impression est disponible.
Ouvrez une invite de commande et entrez la commande suivante :
$ curl http://localhost:8083/api/server/status
1
La réponse est et 1
ou 0
Cela signifie que le serveur est opérationnel ou non et que la configuration du système doit être vérifiée.
Remarque : localhost
doit être remplacé par l'adresse IP/le nom d'hôte de l'ordinateur sur lequel tourne le serveur d'impression.
2. Ajout d'une application API REST
Pour commencer à utiliser un point de terminaison plus avancé, nous devons d'abord définir une application API REST et les champs d'application qui seront utilisés par votre application.
Comment accéder aux applications API REST.
Ouvrir Paramètres tabulation.
Naviguez jusqu'à Systèmes externes.
Sous Applications API REST, cliquez sur Ajouter.
Spécifiez un titre et les champs d'application nécessaires à votre application.
Cliquez sur OK.
Vous pouvez maintenant ouvrir l'application créée et copier votre ID client et votre secret pour obtenir un jeton d'authentification du serveur d'impression.
3. Récupération d'un jeton d'authentification
Pour récupérer votre jeton d'authentification, vous devez appeler endpoint : POST /api/auth/token
avec le corps de la demande spécifié ci-dessous.
Exemple de corps de requête :
{
"grant_type": "client_credentials",
"scope": "jobs offline.access",
"client_id": "7B4CD3C2-F57E-4D52-A90A-23EED001CE81",
"client_secret": "89fbf537fe689fca26f67abae7a557106f4348d5"
}
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"
}
Note : certains points d'accès nécessitent le jeton d'authentification d'un utilisateur existant, ce qui peut être réalisé à l'aide de la fonction login_info
attribut. Plus en Méthodes d'authentification.