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

Smart Data Platform APIの利用開始

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

API鍵更新手順

エンドポイントの一覧

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

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

• 契約者情報：取得／変更
  
• 電話対応（チケット起票代行）：情報取得／新規／変更／廃止
  
• セキュリティヘルプデスク：情報取得／新規／廃止
  
• モバイル情報：取得／変更
  
• モバイル約款：表示／同意
  
• トラフィック収集：同意設定／約款表示／約款同意
  
• ギャランティアクセス：同意設定／約款表示／約款同意
  
• トラフィックレポート（フロー分析）：同意設定／約款表示／約款同意
  
• WANセキュリティ機能：同意設定／約款表示／約款同意
  
• 有償マネージドサービス情報取得
  
• 約款文書ダウンロード

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

• サービスルーター：一覧取得／新規／変更／廃止
• サービスルーター：一括新規／変更
• サービスルーター：操作／操作状況取得／一括操作／操作状況一括取得
• お客さま自営ルーター：一覧取得／新規／変更／廃止
  
• サービスルーターのセキュリティフィルタ遮断カウント更新
• オプションごとのルーター数取得

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

• フレッツ回線別契約型：取得／新規／変更／廃止
• 光回線一括提供型：取得／新規／変更／廃止
• 光回線一括提供型：現地調査日／宅内工事日／撤去日（照会）
• 光回線一括提供型：現地調査日／宅内工事日／撤去日（予約）
• 設置場所住所：検索／提供判定
  
• 光回線一括提供型受付可否取得
• IPoEアクセス回線一覧取得

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

• ギャランティアクセス回線：一覧取得／新規／変更／廃止／回線情報取得
• 設置場所住所：照会／提供判定
• 稼働日照会：現地調査日／宅内工事日／廃止工事日
• 住所登録のお申し込み
• ギャランティ書類ダウンロード
• ギャランティアクセス：BGPリセット／BGPリセット実行結果の取得

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

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

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

• VPN接続：取得／新規／変更／廃止

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

• FIC接続リソース情報：取得／新規／変更／廃止
• FIC接続：BGPリセット／BGPリセット実行結果の取得

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

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

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

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

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

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

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

• アラート：警報一覧取得／ステータスごとの警報数取得
• セルフチェック：実行／結果取得
• 健全性一覧取得（FICリソース以外）
• FICの健全性一覧取得／経路取得
• ステータス毎のルーター数取得
• お知らせ：全てのお知らせ一覧取得／特定のお知らせ取得
• トラフィック一覧取得／トラフィックサマリ取得
• トラフィックレポート（フロー分析）：ランキング取得／データ保存量参照／ランキングデータ保存量参照／フィルタ保存／フィルタ一覧取得／フィルタ削除／アプリケーションID一覧取得

脅威検知
セキュリティサービスの回線別契約情報リストリソース情報の参照・操作に関する機能を有するAPIです。

• 脅威検知詳細：取得／削除
• ルーター遮断：フィルター一覧取得／変更

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

• キャンペーン情報：取得／新規／廃止