OCN Mobile ONE for Business API

回線毎の運用状況(データ利用量等)を取得するAPIがご利用になれます。

Overview

本APIは、OCN Mobile ONE for Business(以下、ForBiz(フォービズ)と略す)用となります。
本APIは、ご契約回線開通後にご利用可能となります。

ForBizのサービス内容につきましては、ForBizをご参照してください。

契約番号(1)配下の回線情報取得と変更および、回線を制御するAPI群です。 [同期API(2)]

(*1) 契約番号とは、N+9桁の 数字となります。(例:N999999123)

(*2) 同期APIとはAPIの応答にその結果が含まれるAPIです。

ForBizは、以下のAPIをご提供します。(2017/07/01時点)

Smart Data Platform API

Smart Data PlatformをAPIでご利用になれます(Smart Data Platform Knowledge Centerへ移動します:Flexible InterConnect APIもこちら)

Arcstar Universal One モバイル グローバル M2M API

お客様のSIMカードを制御するAPIがご利用になれます。

Overview

Arcstar Universal One Mobile Global M2M APIは、ご契約されているSIMカードの制御、情報取得を可能とするAPIを提供します。

詳細仕様については、右側に表示されているGlobal M2M APIを参照ください。(要デベロッパーポータルログイン)

  • Connectivity Directory  
  • Subscription Status
  • Sim Life Cycle Management
  • Traffic Tracking
  • Session History
  • Device Info

Arcstar Universal One 回線アラームAPI

Arcstrar Universal Oneで発生中の回線アラームをAPIにて取得できます

Overview

本APIはArcstrar Universal Oneで発生中の回線アラームを取得するAPIです。
最大過去90日前から発生中のアラームを取得することができます。

Resource URL

グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。

グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、
一番近いAPIゲートウェイに接続します。

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/circuitalarms

2.Base Path(Region)

モバイルアクセス卸 API

モバイルアクセス卸で提供するsimの情報取得やプラン変更を、APIにてご利用になれます

Overview

モバイルアクセス卸 APIは、ご契約されているSIMカードの制御、情報取得を可能とするAPIを提供します。

APIの詳細仕様につきましては、右側に表示されているモバイルアクセス卸 APIを参照ください。(要デベロッパーポータルログイン)

  • 回線基本情報参照
  • 回線運用情報参照
  • 回線追加チャージ(クーポン)容量・期間追加
  • 回線クーポンON/OFF
  • 回線アクティベート/ディアクティベート
  • 回線プラン変更
  • 回線リスト確認
  • SO一覧
  • SO詳細
  • 予約キャンセル

なお、下記[その他API]の内容やご契約に関する各種手続等については、弊社営業またはデベロッパーポータルのサポートからお問い合わせください。

[その他API]

  • 回線グループ系

Arcstar Universal Oneフレキシブルイーサ API

イーサネット専用線/VPNの帯域変更や経路変更を、APIにてご利用になれます

Overview

本APIでは、Arcstar Universal One フレキシブルイーサの帯域変更および経路変更のお申込が可能です。
本APIは、ご契約回線開通後にご利用可能となります。
「Arcstar Universal One フレキシブルイーサ」サービスについては、サービス紹介サイト(ギャランティアクセスイーサネット専用線)をご参照ください。

Arcstar Universal Oneフレキシブルイーサは、以下のAPIを提供します。

Manage allowed ipaddress API

権限管理者アカウントの設定を行うAPIがご利用になれます

Overview(近日公開予定)

本APIは権限管理者アカウント(ビジネスポータルからお申込頂いたアカウント、或いは当社担当者より払い出されたそれに相当するアカウント)のソースIPアドレスの設定を管理するAPIです。

権限管理者アカウントはビジネスポータルから申し込みの際、或いは当社担当者より払い出される際に必ずそのアカウントのソースIPアドレス初期登録を行ってます。 #1

  • #1 2025/8以降新規に発行するアカウントの場合。2025/8以前に発行のアカウントは初期値として一律0.0.0.0.0/0が設定されています。
IPアドレスの制限イメージ

IPアドレスの認可制御イメージは以下の通り。

グループ情報API

Overview

本APIはグループID、グループ名などのグループに紐づく情報を閲覧/登録/変更/削除することができます。

-グループ情報API(情報照会)
-グループ情報API(登録)
-グループ情報API(更新)
-グループ情報API(削除)

 グループ情報API(情報照会)

GET https://api.ntt.com/v1/anpi/maintenance/group/

団体内に登録されているグループ情報を取得します。
一度に取得できる情報は最大1,000件までとなります。

Request Parameters

URL Path Parameter

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意