IBM MaaS360 -Référence d'API pour les services Web

MaaS360® permet aux administrateurs d'accéder à l'API des services web à partir de l'interface utilisateur du IBM® MaaS360 Portal. Contactez IBM Support pour activer cette fonctionnalité pour votre compte MaaS360.

La référence d'API pour les services Web comporte des détails tels que des notes d'implémentation, des attributs obligatoires pour exécuter l'API, des détails de contrôle d'accès, des classes de réponse avec des exemples de modèle ainsi que des détails de paramètre.

Droits d'accessibilité des API de services Web

MaaS360 comprend deux types de droits d'accessibilité pour accéder à l'API des services web à partir du IBM MaaS360 Portal. Affectez les droits d'accessibilité d'API de services Web appropriés aux comptes administrateur avec le rôle admin Service.

  • Accès en lecture : L'administrateur peut consulter la documentation de l'API du service web dans le IBM MaaS360 Portal. Les comptes d'administrateur d'entreprise sont fournis avec un accès en lecture.
  • Accès administrateur : L'administrateur peut consulter et échantillonner la documentation de l'API du service web dans le IBM MaaS360 Portal. Les comptes d'administrateur de client sont fournis avec l'accès admin.

Suivant le type de droits d'accès qui sont affectés à un administrateur, le niveau d'accessibilité de l'API de service Web d'un compte administrateur varie.

Disponibilité de l'API des services Web à partir du portail IBM MaaS360

Les administrateurs ayant les rôles d'accessibilité appropriés peuvent accéder à l'API des services web à partir du IBM MaaS360 Portal. Accédez à Configurer > API de services Web , puis cliquez sur Documentation pour afficher ou exécuter l'API de services Web à partir du portail.

Un compte administrateur ayant un accès admin peut utiliser l'option Try it out pour l'exécution de l'API de services Web.

Remarque : L'API de services Web MaaS360 prend en charge TLS versions 1.1 et suivantes.

Étapes d'exécution de l'API des services Web à partir du IBM MaaS360 Portal

  1. Dans Setup > Web Services API, cliquez sur Documentation.
  2. Accédez à l'API Authentication, entrez les paramètres billing ID et body du client.
  3. Cliquez sur Try it out pour générer un jeton d'authentification.
    Remarque: copiez le jeton d'authentification généré dans le corps de la réponse pour tester toute API de services Web MaaS360 . Une fois généré, le jeton est valide pendant 60 minutes.
  4. Allez à n'importe quel MaaS360 web services API dans le IBM MaaS360 Portal, et fournissez les détails suivants :
    • Tous les paramètres obligatoires dont vous avez besoin pour tester l'API, par exemple l'ID de facturation.
    • Le jeton d'autorisation que vous avez généré à l'étape 3.
      Remarque : Le jeton d'authentification doit être saisi entre guillemets et utiliser le préfixe MaaS token=. Par exemple, MaaS token="xxxxxx".
  5. Cliquez sur Try it out afin de tester l'API de services Web. Les en-têtes d'URL de demande, de corps de réponse, de code de réponse et de réponse sont affichés pour l'API de services Web.
    Remarque : le type de contenu de réponse est application/XML par défaut. Choisissez application/json si le type de contenu de réponse doit être au format JSON.