Smart Data PlatformのAPIをはじめて利用される方へ

Smart Data Platform APIの利用開始

docomo business RINKでは定期的なAPI鍵、API秘密鍵の更新を推奨しております。 以下手順よりご計画の上、API鍵更新を実施してください。

API鍵更新手順

エンドポイントの一覧

docomo business RINKのエンドポイントはこちらの「エンドポイントの一覧」を参照してください。

契約者情報・初期設定（モバイル）
契約情報、電話対応（チケット起票代行）、モバイル情報／約款、トラフィック収集／約款、有償マネージドサービスに関する機能を有するAPIです。

• 契約書情報取得／変更
• 電話対応（チケット起票代行）情報取得／新規／変更／廃止
• モバイル情報取得／変更
• モバイル約款表示／同意
• トラフィック収集の同意／約款表示／約款同意
• 有償マネージドサービス情報取得
• 約款文書ダウンロード

ルーター
ルーターに関する機能を有するAPIです。

• ルーター一覧情報取得
• ルーターの新規／変更／廃止／一括お申し込み／一括変更
• ルーター操作API／ルーター操作状況取得API／ルーター一括操作API／ルーター操作状況一括取得API／ルーター一覧取得（ルーターID指定）

IPoE
IPoE回線（フレッツ別契約回線／光一括提供型回線）に関する機能を有するAPIです。

• フレッツ別契約型回線－新規／取得／更新／廃止
• 光一括提供型回線－新規／取得／更新／廃止
• 光一括提供型回線－現地調査日／宅内工事日／撤去日（照会）
• 光一括提供型回線－現地調査日／宅内工事日／撤去日（予約）
• 設置場所住所検索
• 設置場所住所で提供可能なサービスを確認
• 光一括提供型受付可否取得
• IPoE回線一覧取得

ギャランティ
IWアクセス回線に関する機能を有するAPIです。

• IWアクセス回線－一覧取得／新規／変更／削除／回線情報取得
• 設置場所住所（照会）
• IWアクセス回線の提供可否
• 現地調査日／宅内工事日／撤去日（照会）
• 住所登録のお申し込み

ドキュメント
IPoE回線（光一括提供型）、およびIWアクセス回線の書類に関する機能を有するAPIです。

• 工事関連書類のダウンロード
• 本人確認書類のアップロード

VPN
VPNへの接続に関する機能を有するAPIです。

• VPN接続一覧取得
• VPN接続の新規／変更／削除／情報取得

FIC接続
FICへの接続に関する機能を有するAPIです。

• FIC接続リソース情報一覧取得
• FIC接続リソースの新規／変更／削除／取得
• FIC接続におけるBGPリセット／BGPリセット実行結果の取得

特定通信ブレイクアウト対象リスト一覧
特定通信ブレイクアウト対象リストリソースに関する機能を有するAPIです。

• 特定通信ブレイクアウト対象リストリソース情報の一覧／詳細取得
• 特定通信ブレイクアウト対象リストリソース情報の新規／更新／削除

オーダー
お申し込み履歴に関する機能を有するAPIです。

• お申し込み履歴一覧取得／履歴参照取得／変更／取消し

簡易情報一覧取得
各リソース（ルーター、IPoE回線、VPN、IWアクセス回線、FIC、および申し込み履歴）の簡易的な機能を有するAPIです。

• ルーター簡易情報一覧取得
• IPoE回線簡易情報一覧取得
• VPN簡易情報一覧取得
• ギャランティ簡易情報一覧取得
• FIC接続簡易リソース一覧取得
• 申込履歴 簡易情報一覧

モニタリング
RINKコンソール画面のモニタリングに関する機能を有するAPIです。

• 警報の一覧情報取得
• 指定した期間による日ごとの発生中の警報数／回復済みの警報数の取得
• セルフチェック実行／結果取得
• 健全性一覧取得（FICリソース以外）
• FICの健全性一覧取得／経路取得
• ステータス毎の端末数取得
• 全てのお知らせ一覧取得／特定のお知らせ取得
• トラフィック一覧取得／トラフィックサマリ取得

キャンペーン情報
キャンペーン情報に関する機能を有するAPIです。

• 情報取得／お申し込み／廃止