Soracom

Users

ドキュメント

Sigfox → HTTP/HTTPS エントリポイント

Sigfox デバイスからの Uplink データを HTTP もしくは HTTPS で転送先へリクエストを転送します。

  • 1 つの Sigfox グループに対して 1 個だけ作成できます。
  • Sigfox デバイスはこのエントリポイントのみ使用できます。

設定項目

  • [設定名]: 任意の名前
  • [転送先]
    • [プロトコル]: 転送先への送信プロトコル。HTTP もしくは HTTPS から選択。
    • [ホスト名]: 転送先の FQDN。
    • [ポート番号]: 転送先のポート番号。
    • [パス]: 転送先へのリクエストパス。
  • [ヘッダ操作]
    • [デバイス ID 付与]: 転送先へのリクエストに x-soracom-sigfox-device-id: #{deviceId} を追加します。
    • [署名ヘッダ付与]: 転送先へのリクエストに x-soracom-signature: #{signature} を追加します。
    • [事前共有鍵]: 署名に利用する共通鍵を設定します。詳細は、署名ヘッダと事前共有鍵を使って送信元を検証する を参照してください。
  • [カスタムヘッダ]: 転送先へのリクエストに任意の HTTP ヘッダーを置換、追加、削除できます。

エントリポイント

Sigfox の場合、エントリポイントをデータ送信元で意識する必要はありません。Sigfox グループで Beam を有効化すると自動的にエントリポイントにデータが送信されます。

リクエスト

Beam はオリジナルのリクエストに対して Connection ヘッダーに close を設定、HTTP メソッドは POST、ペイロードフォーマットは JSON としてリクエストを転送します。

このとき、自動的に以下の HTTP ヘッダーを付与します。

  • x-soracom-operator-id: {オペレータID}
  • x-soracom-timestamp: {UNIX 時間 (ミリ秒)}

{UNIX 時間 (ミリ秒)} は、データ送信時刻です。

サンプル header

SORACOM Beam の設定直後の状態

x-soracom-timestamp: 1494817070730
x-soracom-operator-id: YOUR_OPERATOR_ID
connection: close

SORACOM Beam の設定 [ヘッダ操作] 内で設定した場合

設定内容;

  • [デバイス ID 付与] オン: x-soracom-sigfox-device-id が付与されます。
  • [署名ヘッダ付与] オン: x-soracom-signature および x-soracom-signature-version が付与されます。
  • [カスタムヘッダ] x-add-custom、値 foobar を追加
x-soracom-timestamp: 1494817070730
x-soracom-sigfox-device-id: YOUR_SIGFOX_DEVICEID
x-soracom-operator-id: YOUR_OPERATOR_ID
x-add-custom: foobar
x-soracom-signature: 2b6f5126922ace000a88c6df92519acd252364b194b8e1ab3e6a70f29a6ce9a4
x-soracom-signature-version: 20151001
connection: close

サンプル body

リファレンス: SORACOM サービスへ連携されるデータのフォーマット | SORACOM Air for Sigfox を参照してください。

レスポンス

転送先から返された HTTP レスポンスは Beam に到達した際に破棄されます。Sigfox デバイスでは HTTP レスポンスを受け取ることはできません。

転送先からエラーレスポンスが返却された場合には、エラーの内容がログとして記録されます。エラーログは、ユーザーコンソールの「ログ」画面から確認できます。