エントリポイントとは、デバイスから見た Harvest Data/Files へのデータの送信先です。デバイスからのプロトコルごとに以下のエントリポイントが用意されています。
Harvest Data
Harvest Data に新たに送信する場合は、Unified Endpoint のエントリポイントの利用を推奨します。すでに Harvest Data 固有のエントリポイント (harvest.soracom.io など) を利用している実装を変更する必要はありません。エントリポイントを利用してデータを送信する手順について詳しくは、デバイスのデータを SORACOM Harvest Data に保存する を、Unified Endpoint とサービス固有のエントリポイントの違いについては、Unified Endpoint とサービス固有エンドポイントの違いについて を参照してください。
| サービス | 通信プロトコル | エントリポイント |
|---|---|---|
| Air for セルラー / Arc | UDP | uni.soracom.io:23080 (*1) |
| TCP | uni.soracom.io:23080 (*1) (*2) | |
| HTTP | uni.soracom.io (*1) | |
| SMS (*3) / USSD (*4) | 901001 (*1) | |
| Air for LoRaWAN | - | (*5) |
| Air for Sigfox | - | (*5) |
| Inventory | - | (*6) |
- (*1) Harvest Data 固有のエントリポイント に送信しても、Harvest Data を利用できます。
- (*2) SORACOM Binary Format v1 を利用できます。
- (*3) SORACOM への SMS 送信に対応したサブスクリプションで利用できます。詳しくは、SORACOM と SMS を送受信する を参照してください。
- (*4) USSD 送信に対応したサブスクリプションで利用できます。詳しくは、USSD で Beam / Funnel / Funk / Harvest Data にデータを送信する を参照してください。
- (*5) デバイスから送信したデータは、常に Unified Endpoint のエントリポイント に送信されます。グループ設定で Harvest Data を有効化すると、データが Harvest Data に蓄積されます。エントリポイントやプロトコルの指定は不要です。
- (*6) Inventory で管理するデバイスから Harvest Data に送信する場合は、
https://api.soracom.io/v1/devices/${deviceId}/publish?device_secret=${deviceKey.secret}に送信してください。詳しくは、Inventory デバイスから SORACOM Harvest Data にデータを送信する を参照してください。
送信可能なデータサイズには制限があります
TCP でデータを送信する場合 (Unified Endpoint 経由・Harvest Data 固有のエントリポイントのいずれも)、データサイズが MTU (Maximum Transmission Unit。一般的には 1500 バイト) を超えると、複数のデータ (TCP セグメント) に分割されて、Harvest Data に保存されます。MTU を超えるデータを保存する場合は、SORACOM Binary Format v1 の利用や、UDP の利用も検討してください。
HTTP エントリポイントに送信できるデータサイズの上限は、1 リクエストあたり 128 KiB (131072 バイト) です。
Harvest Data 固有のエントリポイント
Harvest Data 固有のエントリポイントに直接送信しても、Harvest Data を利用できます。
| 通信プロトコル | エントリポイント |
|---|---|
| UDP | harvest.soracom.io:8514 |
| TCP | harvest.soracom.io:8514 |
| HTTP | harvest.soracom.io |
| SMS / USSD | 901031 |
Harvest Files
Harvest Files に送信するときは、以下のエントリポイントを利用できます。エントリポイントを利用してデータを送信する手順について詳しくは、デバイスのファイルを Harvest Files にアップロードする を参照してください。
| プロトコル | エントリポイント |
|---|---|
| HTTP | harvest-files.soracom.io |
- Harvest Files は、SORACOM Air for セルラーだけで利用できるサービスです。LoRaWAN デバイス、Sigfox デバイス、Inventory で管理するデバイスでは利用できません。
- HTTP リクエストヘッダー
Content-Lengthでアップロードするサイズを指定してください。
SORACOM CLI / SORACOM API の場合
SORACOM CLI または SORACOM API も利用できます。
- SORACOM CLI を利用する場合は、
soracom files put、soracom files list、およびsoracom files getを使用します。 - SORACOM API を利用する場合は、
FileEntry:putFile API、FileEntry:listFiles API、およびFileEntry:getFile APIを使用します。