目次
APIについて
本サービスで提供する機能については、順次APIによる公開を進めています。お客さまシステムと本サービス提供機能の連携などにご活用ください。
APIの詳細仕様についてはSwagger形式にて公開しております。以下API Documentよりご参照ください。本APIに用いられる用語や概念などは、API 利用ガイドに記載しています。
API Document（Swagger）
API一覧
用語
APIで利用する用語の一覧
| 名称 | システム上の識別子 | 説明 | APIでの取得方法 |
| システム番号 | |||
| ユーザー | |||
共通仕様
本サービスのAPIにおける共通仕様は以下の通りです。
| プロトコル | HTTPS |
| 文字コード | UTF-8 |
| フォーマット | JSON |
| エスケープ文字 | |
| 日時フォーマット |
APIリクエスト数の制限
本APIは、お客さまのご契約システム番号ごとにリクエスト数の制限を設けております。この制限値を超過するAPIリクエストが行われた場合、該当リクエストに対して「Status Code：429 Too Many Request」の応答をいたします。
| リクエスト制限の種類 | 制限内容 |
|---|---|
| Spike Arrest ポリシー |
DDoS攻撃などのトラフィックスパイクから本APIを保護するためのポリシーです。 100ミリ秒未満の間隔で実施されたリクエストを制限いたします。 |
| Quota ポリシー |
一定期間内における同一クライアントからのAPIリクエスト数上限を定義し、クライアント間で公平な利用を促すためのポリシーです。 1分間のAPIリクエスト数が120回を超えるものを制限いたします。 |
アカウント認証（変更の可能性あり）
APIの認証に利用するアカウントについては、初期申込時の管理者設定におけるID（メールアドレス）/パスワードが該当します。お手元の申込書をご確認ください。
アカウント発行・管理
カスタマーコンソールを開通している場合は、こちらの手順からアカウントの確認及び追加削除・パスワード変更が可能です。
パスワード認証
APIリクエスト時におけるパスワード認証方法
トークン認証
APIリクエスト時におけるトークン認証方法
提供中API一覧
提供中APIの一覧は以下の通りです。各API毎の機能概要や条件などは詳細情報欄もしくは左側のメニュー欄から、各APIの詳細ページを参照してください。
| 分類 | API名 | パス | 詳細情報 | Swagger |
| SIM情報参照 | SIM一覧 | 参照 | 参照 | |
| SIM詳細 | 参照 | 参照 | ||
| 申込履歴参照 | 申込一覧 | 参照 | 参照 | |
| 申込詳細 | 参照 | 参照 |
シーケンス図
参照系API
申し込み系API
ユースケース
代表的なユースケース及び参照先の例を提示します
契約SIMの一覧を取得し、指定したSIMの詳細情報を表示させたい
利用するAPI
SIM一覧API（Swagger）
SIM詳細API（Swagger）
シーケンス（図もしくは手順ベース？）
１， SIM一覧APIを参照し、契約中のSIM一覧を取得する
参照サンプル及び取得値の例
２，SIM一覧の取得値より、詳細情報を取得したいSIMの電話番号を参照キーとしてSIM詳細APIを参照する
参照サンプル及び取得値の例
SLA
APIに限らず全体のSLA（SLO？）ページを別途作成する予定