Messaging-API

API-Authentifizierung

Die HTTP-Messaging-API ist durch HTTP-Basisauthentifizierung geschützt. Verwenden Sie den Benutzernamen use-token-auth und das Token, die Sie bei der Einrichtung Ihrer Geräte erstellt haben.

Die HTTP-Messaging-API ermöglicht das Publizieren von Ereignissen und Befehlen durch Anwendungen und Geräte, die nicht von Ereignissen und Befehlen unterschieden werden können, die mit MQTT publiziert werden. Weitere Informationen zu Messaging-API-Schlüsseln und -Tokens finden Sie unter Kommunikation mit Geräten.

URL der HTTP-API

Verwenden Sie die folgenden API-Endpunkt-URLs, um auf die HTTP-Messaging-API zuzugreifen. Die API-Endpunkt-URL besteht aus einer Host-URL und einer Basis-URL. Die Basis-URL ( URL ) für jede REST-API wird in der API-Dokumentation aufgelistet und lautet normalerweise api/v0002/.

Die Host-URL lautet wie folgt:

https://{orgId}.messaging.iot.masdomain.com/{base_URL}

Der {orgId} Wert ist die 6-stellige Organisations-ID Ihrer IoT Werkzeugorganisation. Der {orgId} Wert muss in jedem Hostnamen für einen API-Aufruf von HTTP enthalten sein. Wenn Sie Maximo® Application Suite Dedicated verwenden, finden Sie Ihre Organisations-ID in Ihrem Willkommensschreiben. Wenn Sie sich in einer vom Kunden verwalteten Umgebung befinden, entspricht die Organisations-ID Ihrer Arbeitsbereichs-ID. Ihr Anwendungssuiteadministrator konfiguriert die Arbeitsbereichs-ID während des Installationsprozesses.

Wenn Sie ein Gerät oder eine Anwendung mit dem Quickstart-Service verbinden, geben Sie 'quickstart' als Wert für {orgId} an.

Curl-Beispiel

Das folgende Beispiel zeigt einen API-Aufruf zum Senden eines Geräteereignisses: curl -X POST "https://{orgId}.messaging.iot.masdomain.com//api/v0002/device/types/{deviceType}/devices/{deviceId}/events/{event_name}" -H "content-type: {contenttype}" -d "EventPayload" -u 'use-token-auth:{authentication_token}', wobei {contenttype} einer der folgenden Werte ist: text/plain, application/json, application/xmloder application/octet-stream. und {authentication_token} ist das Authentifizierungstoken, das Sie bei der Registrierung des Geräts erstellt haben.

Weitere Informationen zur Unterstützung IoT von MQTT-Messaging durch das Tool finden Sie unter MQTT-Messaging.