APIセッション認証の仕組み

APIの呼び出しには認証が必要です。ただし、APIを呼び出すたびにユーザ クレデンシャルを提示するのではなく、最初に認証トークンを取得する必要があります。このトークンは最初にユーザ名とパスワードに基づいて生成され、その後のすべてのAPI呼び出しで指定する必要があります。

管理APIには、NAS Bridgeの標準ブラウザ インターフェイス、Swaggerページ、Pythonをはじめとするプログラミング言語など、複数の方法でアクセスできます。どの方法も、認証に関連する論理フローや使用パターンは共通です。APIにアクセスする際に使用する必要がある一般的なフローは次のとおりです。

  1. ユーザ名とパスワードを提示してAPIセッションを作成します。
  2. HTTP応答から認証トークンとその他の情報を抽出します。
  3. 必要に応じて、目的のタスクを実行するために必要な追加のAPI呼び出しを1つ以上実行します。その際に、各呼び出しで認証トークンとその他の情報を指定します。
  4. セッションを削除して認証トークンをリセットします。

つまり、管理APIにアクセスする方法に関係なく、APIを使用する場合は必ず最初に認証トークンを生成し、最後にトークンをリセットします。