Soracom

Users

ドキュメント

Web サイトエントリポイント

デバイスから HTTP リクエストを受け付け、HTTP もしくは HTTPS で転送先へリクエストを転送します。転送先としてホスト (プロトコル、ホスト名、ポート番号) を設定して、すべてのパスに転送できます。デバイスの状況に応じて、転送先のパスを変更するユースケースに向いています。

HTTP エントリポイントとの違いはパスをあらかじめ固定的に決めておく必要がないということです。たとえば http://beam.soracom.io:18080/path/to/targethttps://${TARGET}/path/to/target へ転送されます。

設定項目

SORACOM ユーザーコンソールの場合

  • 設定名: 本設定の名前
  • 転送先
    • プロトコル: 転送先への送信プロトコル (HTTP もしくは HTTPS から選択)
    • ホスト名: 転送先の FQDN
    • ポート番号: 転送先のポート番号
  • ヘッダ操作
    • IMSI ヘッダ付与: 転送先へのリクエストに x-soracom-imsi: ${IMSI} を追加します。
    • IMEI ヘッダ付与: 転送先へのリクエストに x-soracom-imei: ${IMEI} を追加します。
    • MSISDN ヘッダ付与: 転送先へのリクエストに x-soracom-msisdn: ${MSISDN} を追加します。
    • SIM ID ヘッダ付与: 転送先へのリクエストに x-soracom-sim-id: ${SIM_ID} を追加します。
    • 署名ヘッダ付与: 転送先へのリクエストに x-soracom-signature: ${signature} を追加します。
    • 事前共有鍵: 署名に利用する共通鍵を設定します。詳細は、署名ヘッダと事前共有鍵を使って送信元を検証する を参照してください。
  • カスタムヘッダ: 転送先へのリクエストに任意の HTTP ヘッダを付与できます。

SORACOM CLI / SORACOM API の場合

soracom groups put-config (Group:putConfigurationParameters API) を使用します。

{namespace} は、SoracomBeam です。

ボディで指定するプロパティについては、以下の keyvalue のペアを配列で指定します。

"http://beam.soracom.io:18080": { // 固定、スラッシュを含まない
  "name": "string", // 任意の名称
  "destination": "https://example.com", // 通信先のFQDNまでを指定
  "enabled": true | false, // Web サイトエントリポイントの有効無効
  "addSubscriberHeader": true, // Subscriber の情報をヘッダとして付与するか否か
  "customHeaders": { // 独自HTTPヘッダ
    "X-HEADER-NAME": { // 独自ヘッダの名前
      "action": "replace" | "append" | "delete", // 置換、追記、削除が選択可能
      "headerKey": "X-HEADER-NAME",
      "headerValue": "VALUE" // ヘッダに設定する内容
    }
  },
  "addSignature": true | false, // 検証用シグネチャを付与するか否か
  "psk": "string" // 検証用シグネチャを計算する際の事前共有パスフレーズ
}

設定例

[
  {
    "key": "http://beam.soracom.io:18080",
    "value": {
      "name": "test",
      "destination": "https://beamtest.soracom.io",
      "enabled": true,
      "addSubscriberHeader": true,
      "customHeaders": {
        "X-GROUP-NAME": {
          "action": "replace",
          "headerKey": "X-GROUP-NAME",
          "headerValue": "TEST"
        }
      },
      "addSignature": true,
      "psk": "topsecret"
    }
  }
]

Web サイトエントリポイント URL

http://beam.soracom.io:18080

設定上のポートは 18080 となっており、 http://beam.soracom.io:18080 でも通信を行えますが、 http://beam.soracom.io (80 番ポート) に対して通信を行ってもよい状態となっております。

リクエスト / レスポンス

挙動は HTTP エントリポイントと同じです。リクエスト、レスポンス、利用例は エントリポイントリファレンス: HTTP エントリポイント を参照してください。