.NET環境からSORACOMのAPIへとアクセスする非公式SDKです。
Operator
としてログインしたり、自身に紐付いているSubscriber
(SIM)の一覧とその詳細情報を取得したりできます。
これを使うと、たとえば
- Microsoft Azure環境でSORACOM Beamを受けてSIM認証をおこなったり
- モバイル向けのSORACOM管理コンソールをC#で書いたり
- SORACOM上のSIM一覧とその状態をUnityでビジュアライズしたり変更したり
ということをできます。
2015年10月時点では公式の.NET SDKが用意されていなかったのと、本家のREST APIをそのままC#へとマッピングしても使い勝手がイマイチそうだったので作成しました。
バイナリはNuGetパッケージで公開しています。
Install-Package SoraCommonNet
として導入してください。
var op = await Operator.Authenticate("[email protected]", "password");
var subscr = await op.RetrieveSubscriber("111122223333X");
Debug.WriteLine("IMSI: " + subscr.Imsi);
リファレンスはまだ用意していません。
基本的にIntelliSenseで眺めれば気持ちで把握できるAPIになっていると思いますが、取っ掛かりとしてはテストコード(一部コメントアウトされている)を眺めてみてください。
Operator
の新規登録(仮登録メール送信〜登録確認まで)Operator
としてのログイン- トークン更新
Subscriber
(SIM)の一覧取得Subscriber
(SIM)のアクティブ化/非アクティブ化Subscriber
(SIM)の廃止プロテクト(TP)制御
Subscriber
(SIM)の絞込検索- グループ管理
- イベント管理
Operator
のパスワード変更Subscriber
(SIM)の廃止
公式のSORACOM APIはsandboxを持たないため、SoraCommonNetの自動テストは困難です。 ひたすらローカル完結のモックテストをするのも少々不毛な気がしました。
このため、SORACOM APIの応答を模倣したsandbox(というかモック)サービスを作りました。
ソースコードはSoraCommonNetSandbox以下にあります。適宜本リポジトリをcloneしてよしなにサービスを立ち上げてください。
Azure Web Appとして構築したsandboxを置いておきますので、面倒ならsandboxを叩いていただいても構いません(Azure Web Appの無料枠で動作させていますが、利用制限の上限へ達することはないはずです)。
Apache 2.0