docomo business RINK

docomo business RINK API Reference

Smart Data Platform のdocomo business RINKを操作する API 仕様を記載します。

API エンドポイント

Keystone エンドポイント: https://api.ntt.com/keystone
SSS エンドポイント: https://api.ntt.com/sss

API List

契約者情報・初期設定(モバイル)

契約情報取得、モバイル情報取得、トラフィック収集約款、有償マネージドサービスの機能を有するAPIです。

  • 契約書情報取得/変更
  • モバイル情報取得/変更
  • モバイル約款表示/同意設定
  • トラフィック収集約款表示/同意設定
  • 有償マネージドサービス情報取得

ルーター

ルーターのお申し込み、情報取得、変更、取り消しなどの機能を有するAPIです。

  • ルーター登録一覧情報取得
  • ルーターのお申し込み/一括お申し込み/廃止
  • ルーター操作API/状況取得API
  • ルーターお申し込み書類のアップロード

IPoE

IPoE回線のお申し込みにおけるフレッツ別契約回線、および光一括提供型回線情報の取得などの機能を有するAPIです。

  • フレッツ別契約型回線-新規作成/情報取得/更新/廃止
  • 光一括提供型回線-新規作成/情報取得/更新/廃止
  • 光一括提供型回線-現地調査日/工事日/撤去日(照会)
  • 光一括提供型回線-現地調査日/工事日/撤去日(予約)
  • 事業者変更承諾番号発行
  • 書類ダウンロード
  • 光一括提供型受付可否取得
  • IPoE回線一覧取得

VPN

VPNへの接続のお申し込み、情報取得、設定などの機能を有するAPIです。

  • VPNへの接続のお申し込み一覧取得
  • VPNへの接続のお申し込み/情報取得/変更/削除

FIC接続

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

  • FICへの接続情報一覧取得
  • FICへの接続における構成要素の作成/情報取得/変更/削除
  • FICへの接続におけるBGPリセット/BGPリセット実行結果の取得

オーダー

お申し込み履歴に関する情報取得、取り消しなどの機能を有するAPIです。

  • お申し込み履歴一覧取得/履歴参照取得/取消し

モニタリング

SDPポータル画面におけるモニタリングで表示される機能を有するAPIです。

  • 警報(警報の種類と起因内容)の一覧情報取得
  • 指定した期間による日ごとの発生中の警報数/回復済みの警報数の取得
  • セルフチェック結果取得
  • 健全性一覧取得(FICリソース以外)
  • FICの健全性一覧取得
  • ステータス毎の端末数取得
  • お知らせ一覧取得/お知らせ取得
  • トラフィック一覧取得/トラフィックサマリ取得