SORACOM, INC.

User Console »
Documents

API Reference

English日本語中文

SORACOM プラットフォームをプログラムから利用するための API を公開しています。この API リファレンスでは API の仕様が公開されているだけではなく、実際に API をインタラクティブに呼び出してみる事ができます。API の使い方は API 利用ガイドを参照してください。

注意
この API リファレンスから呼び出す API は、認証したアカウントに対して実際に効果を持ちます。すなわち、SORACOM Air の SIM 単位の通信速度制御やグループの操作などはもちろんのこと、SIM の休止や解約といった操作も実行できてしまいますので十分ご注意ください。また、API 実行に伴う課金も実際に発生しますのでご注意ください。

以下のいずれか一方の認証方法を選んで認証ボタンを押してください。

認証キーによる認証:

認証キー ID
認証キー シークレット

SORACOM ユーザーコンソールのアカウントによる認証:

メールアドレス
パスワード

(認証のために、 /v1/auth API を呼び出しています。)

認証に成功すると、以下の欄に API Key と Token が入ります。以後、API Key と Token が必要な API はこれらの値を用いて呼び出されます。

API Key
Token
Operator ID

このリファレンスでは、認証に用いたアカウントで利用可能なカバレッジタイプに対して API を呼び出すことができます。複数のカバレッジタイプに対応したアカウントの場合は API を呼び出す対象のカバレッジタイプを選択してください。


pagetop