SORACOM では、SORACOM プラットフォームをプログラムから利用するための API を公開しています。API の詳細は、SORACOM API リファレンス に掲載されており、仕様を確認できるだけではなく、実際に API をインタラクティブに呼び出してみることができます。
この FAQ では、updateSpeedClass API を例として、API を実行する手順を紹介します。
API リファレンスを使って SORACOM API を実行する方法
1. API 使用のための認証
API リファレンスは、認証キーによる認証と SORACOM ユーザーコンソールのアカウントによる認証の２つの方法があります。今回は、SORACOM ユーザーコンソールのアカウントによる認証を使う方法をご紹介します。
こちらに SORACOM ユーザーコンソールのアカウントのメールアドレスとパスワードを入力して、認証ボタンを押してください。
認証ボタンの下に「認証 OK」と表示されたら、認証完了です。これで API リファレンスで API を実行することが出来ます。
2. API の実行
アカウントを認証すると、API リファレンスでは実際に API を呼び出すことができるようになります。
注意点
- API リファレンスから呼び出す API は、認証したアカウントに対して実際に効果を持ちます。
- SORACOM Air の SIM 単位の通信速度制御やグループの操作などはもちろんのこと、SIM の休止や解約といった操作も実行できてしまいますので十分ご注意ください。
- VPG の作成や「準備中」状態の SIM の利用開始など、リソースの課金が開始される API も実行できてしまいますのでご注意ください。
今回は API の実行例として、 updateSpeedClass API を使用して SIM の通信速度を変更する手順を紹介します。
まず、Subscriber の一覧から updateSpeedClass API を選択します。
API 名をクリックすると API の詳細が表示されます。
Parameters は、API 呼び出しに必要なパラメータの一覧です。Value の欄に (required) と表示されている項目は入力が必須となります。
今回の場合は imsi, speed_class が必須項目ですので、それぞれ入力します。
speed_class には、操作対象となる SIM に指定したい速度クラスを JSON 形式で指定します。JSON 形式で指定するパラメータは、入力欄の右側にある Model, Model Schema で指定形式を説明しています。
パラメータを入力し終わったら「Try it out!」ボタンをクリックします。
3. API 実行結果の確認
「Try it out!」ボタンをクリックすると、実行結果が返ってきます。実行結果の各セクションの意味は以下のとおりです。
Curl
curl コマンドで API を実行するときのコマンド例です。スクリプト等で API を実行する際の参考情報として表示されます。
Response Body
API の実行結果です。設定内容などを確認できます。
Response Code
API の実行結果を表す HTTP レスポンスコードです。この例の場合、HTTP Response Code: 200 OK が返っており、API 実行が成功したことが分かります。
API 実行が失敗したときは、HTTP Response Code: 4xx, 5xx が返ります。よくあるエラーとして、HTTP Resoponse Code: 400 Bad Request があります。この Response Code は、リクエストパラメータの形式に誤りがあることを示していますので、パラメータの形式が正しいかもう一度確認してください。
API リファレンスの使用例の解説は以上で終わりです。他の API も同様に実行できます。