API リファレンスの構造はどのようになっていますか?

API リファレンスは、個別のAPIをまとめるAPIグループ、各APIの詳細、Request/Response の説明で構成されています。

1. API のグループ

API リファレンスでは、各APIを役割別にグループにまとめています。主なグループと役割は以下のとおりです。

Auth

API キー、API トークン、パスワードリセットトークンの発行、検証

Credential 認証情報の作成、更新、削除
Operator オペレーターの作成、登録情報の更新、パスワード変更
Role SAMユーザの権限設定
ShippingAddress 直販での発送先住所に関する操作
User SAM ユーザの設定、操作、権限付与
Subscriber SIM の情報取得、操作、解約
Billing 請求情報の取得
Payment クーポンコード、クレジットカード情報の登録、更新、削除
EventHandler イベントハンドラの情報取得、作成、更新、削除
Order  購入商品の注文状況、見積の作成、承認
Stats  通信量履歴の取得
Group  グループの作成、設定、削除
VirtualPrivateGateway  VPG の作成、変更、削除、Gate の操作

  

2.各APIの詳細画面

個別の API 詳細画面は以下のような構成になっています。API リファレンス上部の認証フォームでアカウントの認証を行うと、実際にAPIを実行することもできます。APIの実行手順はFAQ: 「API リファレンスを使って SORACOM API を実行するには?」を参照してください。

 

 

 

この記事は役に立ちましたか?

0人中0人がこの記事が役に立ったと言っています
他にご質問がございましたら、リクエストを送信してください
Powered by Zendesk