メッセージング API

API 認証

HTTP Messaging API は、HTTP 基本認証で保護されます。 use-token-authには、 デバイスの登録時に作成したユーザー名とトークンを使用します。

HTTP Messaging API を使用すると、MQTT を使用してパブリッシュされたものと区別できないイベントやコマンドを、アプリケーションやデバイスによりパブリッシュすることが可能になります。 Messaging APIのキーおよびトークンの詳細については、MQTT認証をご覧ください。

HTTP API URL

次の API エンドポイント URL を使用して、HTTP Messaging API にアクセスします。 API エンドポイント URL は、ホスト URL とベース URL で構成されます。 各 REST API のベース URL は、API 資料とともにリストされており、通常は api/v0002/です。

ホスト URL は以下のとおりです。

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

{orgId} の値は、ツール組織の6文字の組織IDです。 HTTP APIコールのホスト名には、 {orgId} の値が含まれていなければならない。 Dedicatedをご利用の場合、組織IDはウェルカムレターに記載されています。 お客様管理環境の場合は、組織 ID はワークスペース ID です。 アプリケーション・スイート管理者が、インストール・プロセス中にワークスペース ID を構成します。

デバイスまたはアプリケーションを Quickstart サービスに接続する場合は、 {orgId} 値として「quickstart」を指定します。

Curl の例

以下に、デバイス・イベントを送信するための API 呼び出しの例を示します。 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}'。ここで、 {contenttype} は、 text/plain、 application/json、 application/xml、または application/octet-streamのいずれかです。 {authentication_token} は、デバイスの登録時に作成した認証トークンです。

ツールのMQTTメッセージング・サポートの詳細については、 MQTTメッセージングを参照してください。