Soracom

Unified Endpoint は常に有効化されています。Unified Endpoint のレスポンスのフォーマットや、SORACOM Binary Format v1 を利用するかどうかを設定できます。

1. SIM グループ画面、LoRaWAN グループ画面、Sigfox グループ画面、またはデバイスグループ画面で [Unified Endpoint 設定] をクリックします。

2. 以下の項目を設定します。

   項目	説明
   [レスポンス] → [フォーマット]	Unified Endpoint のレスポンスのフォーマットを設定します。詳しくは、レスポンスの形式を設定する を参照してください。
   [エントリポイント] → [TCP エントリポイント設定]	[SORACOM Binary Format v1 でデータを受信] では、デバイスから TCP で送信したバイナリデータを、SORACOM Binary Format v1 に準拠するものとして処理するかどうかを設定します。 オン: SORACOM Binary Format v1 に準拠するバイナリデータとして処理される。具体的には、複数のパケットが 1 つのメッセージに変換されてから転送される。 オフ: 任意のタイミングで転送される。 バイナリパーサーや Orbit と併用する場合の処理順序 バイナリパーサー や Orbit と併用する場合の処理順序については、SORACOM のエントリポイントに送信したデータの処理順序 を参照してください。

Unified Endpoint のレスポンスの形式を設定する

Unified Endpoint のレスポンスのフォーマットは、グループ設定 の [Unified Endpoint 設定] → [レスポンス] → [フォーマット] で変更できます。

$ echo -n "Hello" | nc -u -w10 uni.soracom.io 23080
200 {"result":"ok","detail":{"SoracomBeam":{"statusCode":200,"contentType":"application/json","body":"Hi","headers":{"date":"Thu, 25 Oct 2024 00:00:00 GMT","content-type":"application/json","content-length":"2","connection":"close","x-amzn-requestid":"12345678-90ab-cdef-1234-567890abcdef","x-amzn-trace-id":"Root=1-23456789-0abcdef1234567890abcdef1;Parent=1234567890abcdef;Sampled=0;Lineage=1:83a40c42:0"}},"SoracomFunk":{"statusCode":200,"body":"IkhpIg==","encoding":"base64"},"SoracomHarvest":{"statusCode":201}}}

$ echo -n "Hello" | nc -u -w10 uni.soracom.io 23080
200 Hi

$ echo -n "Hello" | nc -u -w10 uni.soracom.io 23080
200 "Hi"

$ echo -n "Hello" | nc -u -w10 uni.soracom.io 23080
204

$ echo -n "Hello" | nc -u -w10 uni.soracom.io 23080
201

$ echo -n "Hello" | nc -u -w10 uni.soracom.io 23080
200 {"result":"ok"}

Unified 形式

[フォーマット] で「Auto (デフォルト)」を選択して転送先を複数設定したり、「Unified」を選択すると、Unified 形式のレスポンスが返されます。Unified 形式のフォーマットは以下のとおりです。

ステータスコード

すべての転送先へのリクエストが成功した場合は 200 が、ひとつでも失敗した場合は 207 が返されます。

ボディ

レスポンスの例

すべての転送先で正常に送信できた場合の例

• ステータスコード: 200

• ボディ:

  {
    "result": "ok",
    "detail": {
      "SoracomBeam": {
        "statusCode": 200,
        "contentType": "text/html;charset=utf-8",
        "body": "Success: {\"temperature\"=>12.3, \"humidity\"=>45.6, \"time\"=>\"2024-09-02T12:34:56.789Z\"}",
        "headers": {
          "content-type": "text/html;charset=utf-8",
          "content-length": "84",
          "x-xss-protection": "1; mode=block",
          "x-content-type-options": "nosniff",
          "x-frame-options": "SAMEORIGIN",
          "connection": "close",
          "server": "thin"
        }
      },
      "SoracomHarvest": {
        "statusCode": 201
      }
    }
  }
  

1 つ以上の転送先からエラーが返却された場合

• ステータスコード: 207

• ボディ:

  {
    "result": "ng",
    "detail": {
      "SoracomBeam": {
        "statusCode": 200,
        "contentType": "text/html;charset=utf-8",
        "body": "Success: {\"temperature\"=>12.3, \"humidity\"=>45.6, \"time\"=>\"2024-09-02T12:34:56.789Z\"}",
        "headers": {
          "content-type": "text/html;charset=utf-8",
          "content-length": "84",
          "x-xss-protection": "1; mode=block",
          "x-content-type-options": "nosniff",
          "x-frame-options": "SAMEORIGIN",
          "connection": "close",
          "server": "thin"
        }
      },
      "SoracomHarvest": {
        "statusCode": 400,
        "body": "Invalid custom timestamp value in request"
      }
    }
  }
  

カスタムレスポンス機能

[フォーマット] で「カスタム」を選択すると、あらかじめ設定したレスポンスが常に返されます。成功時、エラー時のレスポンスをそれぞれ固定できます。詳しくは、カスタムレスポンス機能 を参照してください。

すべての転送先に対して正常に送信できた場合は「成功時のレスポンス」が返却されます。いずれかの転送先でエラーが返却された場合は「失敗時のレスポンス」が返却されます。