Soracom

Users

開発者向けツール
Home 開発者向けツール

SORACOM API 利用ガイド

SORACOM では、SORACOM ユーザーコンソールで利用できるほぼすべての機能を、SORACOM API で利用できます。お好きなプログラミング言語やお客様のシステムから SORACOM API を呼び出すことで、IoT SIM をより柔軟に管理できます。

たとえば、SORACOM Air for セルラーの場合は、以下のような機能があります。

機能SORACOM ユーザーコンソールSORACOM API
データ通信速度の変更IoT SIM の速度クラスを変更するSim:updateSimSpeedClass API
使用中 (active) / 休止中 (inactive) のような IoT SIM のステータスの変更IoT SIM のステータスを変更する / 解約するSim:activateSim APISim:deactivateSim APISim:setSimToStandby APISim:suspendSim APISim:terminateSim API
データ通信量の監視IoT SIM のデータ通信量を確認するStats:getAirStatsOfSim APIStats:getAirStats API
IoT SIM の ICCID (IC Card IDentifier)、IMSI (International Mobile Subscriber Identity) や通信モジュールの IMEI (International Mobile Equipment Identity) の取得SIM 管理画面で IoT SIM の情報を確認 / 検索するSim:listSims APISim:getSim API

上記の機能を利用することで、以下のようなことが実現できます。

  • データ通信を行う夜間は、IoT SIM のステータスを使用中 (active) に変更し、通信速度を上げる。一方、データ通信を行わない昼間は、IoT SIM を休止中 (inactive) に変更する。
  • IoT SIM の IMSI と IoT SIM を利用するデバイスの IMEI を取得することで、IoT SIM とデバイスの組み合わせを管理する。

なお、SORACOM Air for セルラーに限らず、そのほかの機能も SORACOM API で操作できます。

Lagoon 3 および Lagoon 2 の Dashboard 操作に関する API はありません。

SORACOM API はインターネットにアクセスできる IoT デバイスや任意のサーバーから利用できます

SORACOM API は、IoT SIM を搭載した IoT デバイスや、インターネット上の任意のサーバーから呼び出せます。一方で、インターネットにアクセスできない環境では SORACOM API を呼び出せません。