API de messagerie
Utilisez l'API de messagerie HTTP pour envoyer des événements depuis des appareils vers IoT l'outil.
Authentification d'API
L'API de messagerie HTTP est protégée par l'authentification de base HTTP. Pour use-token-auth, utilisez le nom d'utilisateur et le jeton que vous avez créés lors de la configuration de vos appareils.
L'API de messagerie HTTP permet la publication des événements et des commandes par des applications et des terminaux qui ne peuvent pas être distingués des événements et des commandes qui sont publiées à l'aide de MQTT. Pour plus d'informations sur les clés et jetons API de messagerie, consultez la section Communication avec les appareils.
URL d'API HTTP
Utilisez les URL de noeud final d'API suivantes pour accéder à l'API de messagerie HTTP. L'URL de noeud final d'API se compose d'une URL hôte et d'une URL de base. L' URL de base de chaque API REST est répertoriée avec la documentation de l'API et est généralement api/v0002/.
L'URL de l'hôte est la suivante :
https://{orgId}.messaging.iot.masdomain.com/{base_URL}
La {orgId} valeur correspond à l'identifiant à 6 caractères de votre organisation IoT d'outils. La {orgId} valeur doit être incluse dans le nom d'hôte pour tout appel API HTTP. Si vous utilisez Maximo® Application Suite Dedicated, votre identifiant d'organisation est indiqué dans votre lettre de bienvenue. Si vous êtes dans un environnement géré par le client, votre ID d'organisation est votre ID d'espace de travail. Votre administrateur de suite d'applications configure l'ID d'espace de travail au cours du processus d'installation.
Si vous connectez un terminal ou une application au service Quickstart, spécifiez'quickstart'comme valeur {orgId} .
Exemple de commande curl
L'exemple suivant illustre un appel d'API pour envoyer un événement de terminal: 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}', où {contenttype} est l'un des suivants: text/plain, application/json, application/xmlou application/octet-stream, et {authentication_token} est le jeton d'authentification que vous avez créé lors de l'enregistrement de l'appareil.
Pour plus d'informations sur la prise en charge de IoT la messagerie MQTT par l'outil, consultez la section Messagerie MQTT.