FutureNet

NXR,VXRシリーズ

REST-API編

1. REST-API機能の利用方法およびAuth-IDの発行

1-1. REST-API機能を利用する前に

REST-API機能を利用することで、HTTP経由でNXR（以下ルータ）上の情報を読み書きすることができます。

REST-APIの有効化

REST-API機能による操作を行うためには、ルータ側で以下のどちらか（または両方）の設定が必要です。

rest http enable
rest https enable（推奨）

その他設定については、各製品のユーザーズガイドをご参照ください。
なお、初期状態（工場出荷状態のコンフィグ）で起動した場合、http/https共に無効になっています。また、工場出荷状態のコンフィグ起動ではない状態で、REST-API機能未対応バージョンからREST-API機能対応バージョンにアップデートした場合、REST-API機能は無効になっています。
(☞) NXR-530はVer21.6.0、NXR-G100シリーズはVer6.22.1より工場出荷状態で起動時、rest http/https共に無効に変更しました。（それ以前のバージョンではrest https enableが設定されています）

REST-APIへのアクセス方法

操作端末からルータへのアクセス方法は下記のとおりです。

http://ルータのIPアドレス:54080/api/{VERSION}/・・・
https://ルータのIPアドレス:54443/api/{VERSION}/・・・

VERSIONはv1またv2が指定可能ですが、NXR-G100シリーズ以外の機種ではv2の利用を推奨します（REST-APIv1は一部機種を除いて廃止となります）。そして、VERSION以降のURIは機能毎に異なります。また、このポート番号は初期値であり、設定による変更が可能です。

※REST-APIへのアクセスは、HTTPSの利用を推奨します。

認証方式

REST-API機能ではアクセスする際、原則2つの認証が必要になります。

ベーシック認証
Auth-ID

ベーシック認証

REST-API機能アクセス時には、原則ベーシック認証が必要になります。
なお、初期値のユーザID,パスワードは下記のとおりです。また、設定による変更が可能です。設定変更はこちら

ユーザID: rest
パスワード: rest

※一部機種ではユーザIDの複数設定、およびアクセス権限を指定することが可能です。詳細はこちら

※一部機種ではAuth-ID取得後、ベーシック認証をスキップすることが可能です。詳細はこちら

Auth-ID

Auth-IDとは、REST-APIへアクセスする際に必要となるIDです。REST-APIを使用する場合、まず最初にこのAuth-IDを取得する必要があります。
Auth-IDの取得方法はこちら

Auth-ID取得後、そのIDを使用して操作端末からルータのREST-APIにアクセスします。なお、Auth-IDはヘッダで以下のように指定します。

x-auth-id: Auth-ID

例) Auth-IDが1234567890abcdefの場合

x-auth-id: 1234567890abcdef

REST-APIでのアクセス例

Auth-ID取得後、操作端末からルータのREST-APIにアクセスします。以下はREST-APIを使用してルータのファームウェアバージョンを確認する例です。

NXR-530のファームウェアバージョンを確認する

この例では以下の条件でREST-APIへアクセスします。

メソッドおよびURI: GET https://ルータのIPアドレス:54443/api/v2/maint/firmware/version
ベーシック認証用ID,パスワード
Acceptヘッダ: application/json
x-auth-id: 1234567890abcdef

アクセス後、以下のようなレスポンスがあります。

ステータスコード: 200 OK
Content-Type: application/json

{
“model”: “NXR-530″,
“version”: “21.11.13”,
“build”: 10
}

ベーシック認証用アカウント設定およびアクセス権限設定

ベーシック認証用のアカウント設定は初期値から変更することが可能です。また、一部機種では複数アカウント設定、およびアクセス権限を指定することが可能です。

<ベーシック認証用アカウント設定>

(config)#rest username [ユーザID] password [パスワード]

ベーシック認証用ユーザID,パスワードを設定・変更します。

<ベーシック認証用アカウント設定およびアクセス権限設定>

複数アカウント設定、およびアクセス権限として「読み書き可」、「読み取りのみ」を指定することができます。

【複数アカウントおよびアクセス権限設定対応機種】

NXR-650,NXR-610Xシリーズ,NXR-G120シリーズ（2023/11現在）

設定例で使用している機能の対応状況は、各製品の更新履歴やユーザーズガイドをご確認ください。

読み書き可

(config)#rest username [ユーザID] password [パスワード] permit read-write

ベーシック認証用ユーザID,パスワードを設定します。また、アクセス権として読み書き可を指定します。

読み取りのみ

(config)#rest username [ユーザID] password [パスワード] permit read

ベーシック認証用ユーザID,パスワードを設定します。また、アクセス権として読み取りのみを指定します。

Auth-ID取得後のベーシック認証のスキップ

Auth-ID取得後、/api/v2/auth アクセス時以外でベーシック認証をスキップすることができます。

【 Auth-ID取得後のベーシック認証のスキップ対応機種】

NXR-650,NXR-610Xシリーズ,NXR-530,NXR-G120シリーズ（2023/11現在）