1. 概要

管理APIは、YNOマネージャーを外部システム (Webサービスやお客様ご自身で作成したアプリケーション) から利用するためのREST APIです。管理APIを使用することで、外部システムとYNOマネージャーを連携できます。YNOマネージャーと連携することで、YNOの機能を活用した独自のWebサービスやアプリケーションを開発できます。

例えば、以下のようなことができます。

■アプリケーションと連携
管理APIを経由して定期的に機器のCONFIGを取得し端末に保存するアプリケーションを作成することで、お客様ご自身の端末にCONFIGをバックアップできます。

■Webサービスと連携
管理APIを経由してWebサービスから機器の情報を定期的に取得し、お客様ご自身で運用するネットワーク管理画面に表示できます。

管理APIは、外部システムからの利用を想定しています。外部システムについては、お客様ご自身での開発が必要となります。

利用できるAPIや、リクエスト方法などについては、 管理APIリファレンス を参照してください。

YNOマネージャーのGUIには、管理APIを使用するための以下の機能があります。

2. 管理APIを使用する手順

管理APIを使用する手順は、以下のとおりです。

2.1. アカウントの管理APIを有効にする

管理APIを有効にする手順は、以下のとおりです。

  1. 画面右上の「(アカウント名)」 → 「アカウントの編集」を選択し、「アカウントの編集」画面を開きます。
    アカウントの編集_開始

  2. 「管理API」のチェックボックスにチェックを入れ、「確認」ボタンを押します。
    アカウントの編集_チェックを入れる

  3. 「管理API」にチェックマークが表示されていることを確認し、「確定」ボタンを押します。
    アカウントの編集_確認

  4. アカウントの情報が更新されます。

2.3. IPアドレス許可ルールを作成する

必要に応じて、 IPアドレス許可ルールを作成 します。IPアドレス許可ルールを設定することで、管理APIにリクエストできるIPアドレスを制限できます。

IPアドレス許可ルールを設定しない場合、すべてのIPアドレスからリクエストを受け付けます。

2.4. 管理APIにリクエストする

管理APIにリクエストする手順については、 管理APIリファレンス を参照してください。

管理APIのリクエストには、以下の制限があります。

  • 1分あたりのAPIコール回数 (リクエスト回数) :180回まで

  • 1日あたりのAPIコール回数 (リクエスト回数) :30,000回まで

  • 1日あたりのデータ転送 (レスポンスのデータ量) :100MBまで

1日あたりの管理APIの使用状況は 「管理API使用状況」画面 で確認できます。