IBM MaaS360 -API-Referenz für Web-Services

MaaS360® ermöglicht Administratoren den Zugriff auf die Webservice-API von der Benutzeroberfläche IBM® MaaS360 Portal. Wenden Sie sich an den IBM Support, um diese Funktion für Ihr MaaS360 Konto zu aktivieren.

Die API-Referenz für Web-Services enthält Details wie Implementierungsanmerkungen, obligatorische Attribute für die Ausführung der API, Zugriffssteuerungsdetails, Antwortklassen mit Modellbeispielen und Parameterdetails.

Zugriffsrechte für die Web-Service-API

MaaS360 umfasst zwei Arten von Zugriffsrechten für den Zugriff auf die Webdienste-API vom IBM MaaS360 Portal. Weisen Sie Administratorkonten mit der Rolle "Serviceadministrator" die entsprechenden Zugriffsrechte für die Web-Service-API zu.

  • Lesezugriff: Der Administrator kann die Webdienst-API-Dokumentation im IBM MaaS360 Portal einsehen. Geschäftsadministratorkonten werden mit Lesezugriff bereitgestellt.
  • Admin-Zugang: Der Administrator kann die Webdienst-API-Dokumentation im IBM MaaS360 Portal einsehen und ausprobieren. Kundenadministratorkonten werden mit Administratorzugriff bereitgestellt.

Je nach dem Typ der Zugriffsrechte, die einem Administrator zugewiesen werden, variiert die Zugriffsstufe der Web-Service-API für ein Administratorkonto.

Verfügbarkeit der Webdienste-API über das IBM MaaS360 Portal

Administratoren mit den entsprechenden Zugriffsrollen können über das IBM MaaS360-Portal auf die Webservice-API zugreifen. Rufen Sie Setup > Web Services API auf und klicken Sie anschließend auf Dokumentation , um die Web-Service-API im Portal anzuzeigen oder auszuführen.

Ein Administratorkonto mit Administratorzugriff kann die Option Try it out für die Ausführung der Web-Service-API verwenden.

Anmerkung: Die MaaS360-Web-Service-API unterstützt TLS Version 1.1 und höher.

Schritte zur Ausführung von Webservices API aus dem IBM MaaS360 Portal

  1. Klicken Sie unter Setup > Web Services APIauf Dokumentation.
  2. Wechseln Sie zur API Authentifizierung, geben Sie die Kundenparameter billing ID und body ein.
  3. Klicken Sie auf Try it out, um ein Authentifizierungstoken zu generieren.
    Anmerkung: Kopieren Sie das generierte Authentifizierungstoken im Antworthauptteil, um eine MaaS360 -Web-Service-API auszuprobieren. Das Token ist nach der Generierung 60 Minuten lang gültig.
  4. Gehen Sie zu einer beliebigen MaaS360 Web Services API im IBM MaaS360 Portal und geben Sie die folgenden Details an:
    • Alle obligatorischen Parameter, die Sie zum Testen der API benötigen, z. B. die Rechnungsnummer
    • In Schritt 3 generiertes Berechtigungstoken
      Anmerkung: Der Wert für das Authentifizierungstoken muss in Anführungszeichen eingegeben werden und das Präfix MaaS token=verwenden. Beispiel: MaaS token="xxxxxx".
  5. Klicken Sie auf Try it out, um die Web-Service-API zu testen. Die Anforderungs-URL, der Antworthauptteil, der Antwortcode und die Antwortheader für die Web-Service-API werden angezeigt.
    Anmerkung: Der Antwortinhaltstyp ist standardmäßig application/XML. Wählen Sie application/json aus, wenn das JSON-Format als Antwortinhaltstyp verwendet werden muss.