• ドキュメント
• SORACOM Beam
• エントリポイントリファレンス

HTTP エントリポイント

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

HTTP エントリポイントを設定する

HTTP エントリポイントで設定できる項目は以下のとおりです。

[ヘッダ操作]

転送先へのリクエストに追加するヘッダーを設定します。

SORACOM CLI / SORACOM API の場合

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

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

SORACOM CLI のコマンド例:

$ soracom groups put-config --group-id {group_id} --namespace SoracomBeam \
--body '[
  {
    "key": "http://beam.soracom.io:8888/",
    "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
      }
    }
  }
]'

HTTP エントリポイントの 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	lambda を指定します。 HTTP エントリポイントでは、s3 は指定できません。
  region	String	AWS Lambda 関数のリージョンを指定します。例: ap-northeast-1
  credentials.$credentialsId	String	認証情報ストアに登録した AWS IAM ロール認証情報 の認証情報 ID を指定します。

• addAuthorizationHeader.type が bearer または basic の場合:

  key	value の型	value
  credentials.$credentialsId	String	addAuthorizationHeader.type が bearer の場合は、認証情報ストアに登録した API トークン認証情報 または 事前共有鍵 の認証情報 ID を指定します。 addAuthorizationHeader.type が basic の場合は、認証情報ストアに登録した ユーザ名・パスワード認証情報 の認証情報 ID を指定します。

HTTP エントリポイントにリクエストする

リクエスト

エントリポイントに、デバイスからデータを送信します。エントリポイントは、グループ設定の [SORACOM Beam 設定] → (HTTP エントリポイント) → [エントリポイント] に表示されています。

以下は、デバイスから HTTP エントリポイントにデータを送信する場合の例です。

$ curl -v -X POST http://beam.soracom.io:8888/ \
-H "Content-Type:application/json" \
-d '{
  "key": "value"
}'

Note: Unnecessary use of -X or --request, POST is already inferred.
*   Trying 100.127.127.100...
* Connected to beam.soracom.io (100.127.127.100) port 8888 (#0)
> POST / HTTP/1.1
> Host: beam.soracom.io:8888
> User-Agent: curl/7.49.0
> Accept: */*
> Content-Type:application/json
> Content-Length: 15
>
* upload completely sent off: 15 out of 15 bytes
< HTTP/1.1 200 OK
< Content-Type: application/json
< Date: Wed, 21 Dec 2016 02:25:01 GMT
< Connection: close
< Transfer-Encoding: chunked
<
* Closing connection 0

デバイスからの HTTP リクエストを転送先の URL に転送する際、Beam によって以下のヘッダー操作が行われます。

• Connection: close が追加されます。
• [カスタムヘッダ] に指定したカスタムヘッダーが、追加、置換、削除されます。設定内容は、グループ設定の [SORACOM Beam 設定] → [HTTP エントリポイント] → [ヘッダ操作] に表示されます。

レスポンス

Beam は、転送先から Beam に返された HTTP レスポンスを、そのままデバイスに転送します。