Appeler des API REST à l'aide d'un client HTTP
IBM Sterling® Order Management System prend en charge l'authentification de base et l'authentification standard pour l'appel des API REST. Par défaut, l'authentification REST est définie sur l'authentification standard. Pour définir le style d'authentification à utiliser, procédez comme suit:
- Configurez les propriétés de style d'authentification.
- Redémarrez les serveurs d'applications.
- Démarrez l'API REST en configurant le style d'authentification HTTP.
Configurer les propriétés de style d'authentification
Par défaut, servlet.authstyle
est défini sur STANDARD. IBM recommande l'authentification standard dans un environnement plus élevé. Vous pouvez utiliser le style d'authentification BASIC ou STANDARD en fonction de vos besoins métier.
Configurez le xapirest.properties pour votre type d'environnement en cours. Définissez la propriété servlet.authstyle
sur BASIC ou STANDARD. En fonction de votre type d'environnement, vous pouvez définir les propriétés dans le fichier customer_overrides.properties de la boîte à outils de développement ou en utilisant l' administrateur de gestion du système dans l'instance cloud de Sterling™ Order Management System.
Pour plus d'informations sur xapirest.properties, voir xapirest.properties.
Si vous souhaitez utiliser HTTP REST XAPI Tester pour le développement et les tests, consultez la section Configuration de HTTP REST XAPI Tester.
Redémarrer les serveurs d'applications
Vous devez redémarrer tous les serveurs d'applications lorsque vous modifiez le style d'authentification.
Pour plus d'informations, voir Gestion des processus serveur sur la plateforme de nouvelle génération.
Appeler l'API REST en configurant le style d'authentification HTTP
- Appelez l'API de connexion via REST en utilisant l' URL suivante :
http://<ip-address>:<port>//smcfs/restapi/invoke/login
Méthode-POST
Type de support-
application/json
- Fournissez le contenu à la connexion:
{ "LoginID" : "yourUserLogin", "Password" : "UserPassword" }
L'API renvoie les résultats suivants:"UserGroupID": "ItemAdministratorGroup", "UserToken": "mXffVPKgo9HUoftxg0HsyX3uQQP6o4LmAG3HHnfiVTrtQvx3dyYUX8n6793wggmU15", "UserName": "Administrator",
- Utilisez le UserToken qui est généré lors de l'appel de connexion dans les appels suivants. L'utilisateur inclut _loginid et _token comme paramètres de requête dans l' URL l'API REST.Par exemple, pour lancer l'API serveur (GET), utilisez l' URL suivante :
http://localhost:<port>/smcfs/restapi/server?_loginid=admin&_token=mXffVPKgo9HUoftxg0HsyX3uQQP6o4LmAG3HHnfiVTrtQvx3dyYUX8n6793wggmU15
- Obtenez un jeton codé base64 qui se compose du nom de connexion de l'utilisateur et de la valeur confidentielle de l'utilisateur. Concaténez ces valeurs à l'aide d'un signe deux-points. Par exemple, si le nom d'utilisateur est testuser et que le mot de passe est testsecret, vous pouvez exécuter la commande suivante à l'aide d'un encodeur base64 :
echo -n "testuser:testsecret"|openssl base64
Résultats :dGVzdHVzZXI6dGVzdHNlY3JldA==
Utilisez ce jeton comme jeton de base pour l'authentification lors d'un appel d'API REST.
- Appelez l'API REST à l'aide du jeton base64 de base.Inclure la valeur suivante dans l'en-tête de la requête HTTP :Exemple :
Authorization: BASIC
curl --location --request GET 'http://localhost:/smcfs/restapi/server'
--header 'Authorization: Basic dGVzdHVzZXI6dGVzdHNlY3JldA=='
--header 'Content-Type: application/json'
Pour plus d'informations sur l'appel du service d'API REST, voir Appel des services REST.
Pour plus d'informations, voir Sécurité des API.