Soracom

Users

開発者向けツール

SORACOM API 利用ガイド

SORACOM では、IoT SIM など各種サービスの操作を API から行うことができます。このガイドでは、SORACOM API に関する用語や概念と、API の基本的な利用方法を解説します。

用語と概念

SORACOM プラットフォームの用語では、電気通信事業者としてのアナロジーが使われています。

API で管理する対象の IoT SIM のことを Subscriber (サブスクライバー) と呼び、Subscriber を所有するアカウントのことを Operator (オペレーター) と呼びます。SORACOM ユーザーコンソールでログインする際のアカウントが Operator に相当します。

ひとつの Operator は複数の Subscriber を所有できます。Subscriber をまとめて管理する単位を Group (グループ) と呼び、Operator は複数の Group を所有できます。SORACOM Beam など、各種サービスの設定は Group 単位で適用され、同じグループに所属する Subscriber すべてにその設定が反映されます。Subscriber は最大で 1 つの Group に所属できます。(どの Group にも所属しなくても問題ありません)

IoT SIM (Subscriber) には、日本国内向け IoT SIM と、海外でも使える SORACOM IoT SIM の 2 種類があります。IoT SIM のサービス提供エリアは Coverage Type (カバレッジタイプ) と呼び、日本国内向けのものを Japan Coverage (日本カバレッジ)、グローバル向けのものを Global Coverage (グローバルカバレッジ) と呼びます。Coverage Type は IoT SIM の申し込み時点から固定で、後で切り替えることはできません。

ここまでに出てきた用語を図にまとめると以下のとおりです。

SORACOM プラットフォームの用語とガイド SORACOM プラットフォームの用語とガイド

SORACOM Lagoon のダッシュボード操作に関する API はありません。

はじめに

Getting Started

API を利用した自動化

リファレンス