Soracom

Web サイトエントリポイント (http://beam.soracom.io:18080 または http://beam.soracom.io (80 番ポート)) に、デバイスから送信された HTTP リクエストや WebSocket の接続リクエストを HTTP、HTTPS、WebSocket (WS) もしくは WebSocket Protocol over TLS (WSS) で指定のホストに転送します。なお、送信時に指定したパスはすべてそのまま引き継がれます。デバイスの状況に応じて、転送先のパスを変更するユースケースに向いています。

Web サイトエントリポイントには、転送先として 1 つのホスト (プロトコル、ホスト名、ポート番号) を設定します。たとえば、転送先としてプロトコル HTTPS、ホスト名 example.com、ポート番号 443 を指定した場合、デバイスからの送信先に応じて、Beam からの転送先が以下のように決定されます。

Web サイトエントリポイントを設定する

設定画面を表示する操作については、SORACOM Beam のエントリポイントを設定する を参照してください。Web サイトエントリポイントで設定できる項目は以下のとおりです。

SORACOM CLI / SORACOM API の場合

グループ設定に Beam のエントリポイントを追加するコマンドについては、SORACOM Beam のエントリポイントを設定する の SORACOM CLI / SORACOM API の場合 を参照してください。

ここでは、HTTP エントリポイントを追加する場合のリクエストボディに指定する key と value のペアを説明します。

SORACOM CLI のコマンド例:

$ soracom groups put-config --group-id {group_id} --namespace SoracomBeam \
--body '[
  {
    "key": "http://beam.soracom.io:18080",
    "value": {
      "name": "test",
      "enabled": true,
      "destination": "https://beamtest.soracom.io",
      "addSubscriberHeader": true,
      "addSimIdHeader": true,
      "addMsisdnHeader": true,
      "addEquipmentHeader": true,
      "addSignature": true,
      "psk": {
        "$credentialsId": "CredentialsID"
      },
      "customHeaders": {
        "X-GROUP-NAME": {
          "action": "replace",
          "headerKey": "X-GROUP-NAME",
          "headerValue": "TEST"
        }
      },
      "addAuthorizationHeader": {
        "enabled": false
      }
    }
  }
]'

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

以下の key と value を指定します。なお、この key と value のペアは、通常の JSON Object として指定します。

addAuthorizationHeader.config の Object

HTTP エントリポイントの Object のうち、addAuthorizationHeader.config の設定内容は、addAuthorizationHeader.type の設定によって異なります。

• addAuthorizationHeader.type が bearer_jwt の場合:

  key	value の型	value
  jwtClaims	Object	JSON Web Token の生成に使う情報を指定します。 例: { "iss": "soracom-beam@long-stack-371107.iam.gserviceaccount.com", "sub": "soracom-beam@long-stack-371107.iam.gserviceaccount.com", "aud": "https://pubsub.googleapis.com/google.pubsub.v1.Publisher" } iat および exp は、デバイスが Beam にアクセスしたときに、自動的に生成されます。
  credentials.$credentialsId *	String	認証情報ストアに登録した Google Service Account (JSON) または 秘密鍵 (PEM) の認証情報 ID を指定します。
  algorithm *	String	署名アルゴリズムを指定します。 RS256 ES256 RS512 ES512

• addAuthorizationHeader.type が aws_sig_v4 の場合:

  key	value の型	value
  service *	String	geo、lambda、s3、または sagemaker を指定します。
  region *	String	AWS のリージョンを指定します。例: ap-northeast-1
  unsignedPayload	Boolean	Amazon S3 にファイルサイズが 1 MiB を超えるファイルをアップロードする可能性がある場合は、true を指定します。
  credentials.$credentialsId *	String	認証情報ストアに登録した AWS IAM ロール認証情報 の認証情報 ID を指定します。

• addAuthorizationHeader.type が bearer の場合:

  key	value の型	value
  credentials.$credentialsId *	String	認証情報ストアに登録した API トークン認証情報 または 事前共有鍵 の認証情報 ID を指定します。

• addAuthorizationHeader.type が basic の場合:

  key	value の型	value
  credentials.$credentialsId *	String	認証情報ストアに登録した ユーザ名・パスワード認証情報 の認証情報 ID を指定します。

Web サイトエントリポイントにリクエストする

HTTP リクエストを送信する

Web サイトエントリポイントの挙動は HTTP エントリポイントと同じです。詳しくは、HTTP エントリポイントにリクエストする を参照してください。

WebSocket を利用する

Web サイトエントリポイントに WebSocket の接続リクエストを送信し、メッセージを送信します。Web サイトエントリポイントは、グループ設定の [SORACOM Beam 設定] → Web サイトエントリポイントの [エントリポイント] に表示されています。

以下は、デバイスから Node.js と "ws" npm ライブラリ を使って Web サイトエントリポイント (http://beam.soracom.io:18080/) に接続して、データを送信する場合の例です。

const WebSocket = require("ws");

const url = "http://beam.soracom.io:18080";
const ws = new WebSocket(url);

ws.on("open", () => {
  console.log("Connection opened");
  ws.send("Hello, WebSocket!"); // サーバーにメッセージを送信
});

ws.on("message", (data) => {
  console.log("Server:", data.toString());
  ws.close(); // 応答を受け取った後、接続を閉じます
});

ws.on("close", () => {
  console.log("Connection closed");
});

ws.on("error", (e) => {
  console.error("Connection error: " + e.message);
});

HTTPS テストサーバーと WebSocket で通信する

SORACOM Beam の HTTPS テストサーバーは、WebSocket 通信をサポートしています。詳しくは HTTPS テストサーバーと WebSocket で通信する を参照してください。