こんにちは、Customer Reliability Engineer (CRE) の三國です。
ソラコムの CRE チームは「ドキュメントの充実やお客様サポートといった直接の対話を通じて、安心してお使いいただけるIoTプラットフォーム」を実現するため、日々ユーザードキュメントや FAQ のアップデートやお客様のサポートに取り組んでおります。先日の SORACOM Technology Camp 2020 では CRE チームメンバーによるセッションもありましたので、よろしければご覧ください。
この「Ask SORACOM」ブログでは、多くのお客様のナレッジとできるようなお問い合わせ・回答・ドキュメントを紹介しています。SORACOM サービスのご利用にあたって気付きになれば幸いです。なおお問い合わせ内容についてはお客様より許可を頂いて掲載しております。
今回はお客様に頂いたご質問をもとに API の活用パターンドキュメントを作成した話です。早速紹介していきます。
質問: 自社開発のアプリケーション上で SORACOM IoT SIM の発注や登録作業を自動化する方法はありますか？
回答: こちらのご質問は他のお客様にとっても非常に有益な情報になると考えたため、API (Application Programming Interface アプリケーション プログラミング インターフェース) を使った具体的な手順やその検証方法をドキュメントにまとめました！
SORACOM IoT SIM は 1 枚単位で SORACOM IoT ストアやユーザーコンソールから発注できます。数枚単位であればブラウザから都度ご発注いただき、届いた SIM を確認して名前を変更したりグループへ所属させたりできますが、数十枚、数百枚単位で利用するフェーズになるとシステムによる自動化が必要になります。
実は、SORACOM ユーザーコンソールで操作できる機能は、ほとんどが API で呼び出し可能です。ブラウザの開発者ツールで操作の様子を見ると、どのような API を呼び出しているかが確認できます。また、API と各種 SORACOM サービスの紐づけも過去の Ask SORACOM ブログで紹介しています。
このため、SIM の発注すら API でできてしまいますし、発注した SIM の識別子である IMSI を API で確認して SIM の名前や所属するグループも API で設定できます。すなわち、SIM の受け取りなどの物理的な作業を除き、一連のプロセスをほとんど自動化できるのです。
Tips: 自動化を検証するための Sandbox 環境の紹介
しかし、ここで問題があります。特に SIM の注文のような費用が発生する作業を API で自動化したい場合、どうやってテストするのが良いでしょうか？テストのためだけに実際の SIM を発注するのは、心理的なプレッシャーも高いと思います。このような問題を解決するため、SORACOM では SIM の発注や解約といった検証しづらい操作も簡単・無料でお試しいただけるよう、Sandbox 環境を提供しています。Sandbox 環境の設定方法や、Sandbox 操作のための API についてもユーザードキュメントにまとまっておりますので、合わせてご参照ください。
ソラコムでは、今後もお客様からのフィードバックをナレッジの共有やドキュメントの拡充、サービスのフィードバックに努めてまいります。ご要望やご質問はサポート窓口にお寄せください。私たち CRE チームを始め、ソラコムメンバー全員でより良いサービス提供に努めます。
Ask SORACOM の過去記事はこちらをご覧ください。
それでは、次回もお楽しみに！
― ソラコム “Mick” 三國