概要
Signals Notebookは外部アプリケーションやスクリプトからアクセス可能なAPIを提供しています。通常APIはお客様が開発するプログラムから利用されますが、簡易にAPIの動作を確認するためには、各Signals Notebookテナントに備わっているGUIツールであるSwagger UIページを利用することが便利です。
Swagger UI使用手順
どの権限でAPI呼び出しを行うかによって、以下の「A」「B」いずれかの手順をご利用ください。
A. 管理者がその権限でAPIを呼ぶ場合
- Signals Notebookへサインインして下さい。
- Signals Configurationアプリを開き、管理者のユーザー名とパスワードでサインインして下さい。
- 画面上端のアイコンリストから"System Settings"をクリックして下さい。
- 画面左のメニューから"API Key"をクリックして下さい。
- 右側のペインに表示されている"Open External API Document"リンクをクリックして下さい。
- 利用可能なAPIがリストされたページ(Swagger UI)が開かれます。
- このままこのページから各APIセクションの下にあるAPI毎の"Try it out"ボタンをクリックすることにより、ログイン済みの権限でAPI呼び出しを試すことができます。
B. 特定のユーザーのAPIキーを使用してAPIを呼ぶ場合
- Signals Notebookへサインインして下さい。
- Signals Configurationアプリを開き、管理者のユーザー名とパスワードでサインインして下さい。
- 画面上端のアイコンリストから"System Settings"をクリックして下さい。
- 画面左のメニューから"API Key"をクリックして下さい。
- 目的のユーザーに紐づくAPIキーが無い場合、次の方法でAPIキーを作成して下さい。
- "Add New API Key"ボタンをクリックして下さい。
- プルダウンリストから目的のユーザーを探して選択し、"Generate API Key"ボタンをクリックして下さい。
- "Add New API Key"ボタンをクリックして下さい。
- 作成したAPIキーの文字列をコピーします。
- 右側のペインに表示されている"Open External API Document"リンクをクリックして下さい。
- 利用可能なAPIがリストされたページ(Swagger UI)が開かれます。
- 画面のやや上側にある"Authorize"ボタンをクリックして下さい。
- 表示されたテキストボックスへ、コピーしてあるAPIキーの値をペーストし、"Authorize"ボタンをクリックします。
- このページから各APIセクションの下にあるAPI毎の"Try it out"ボタンをクリックすることにより、APIキーに紐づくユーザーの権限でAPI呼び出しを試すことができます。
Swagger UI動作確認
Swagger UIを開きましたら、動作確認のために、パラメーターを必要としない"GET /entities" APIを呼び出してみます。
- 見出しが"Entities"と表示されているセクションの下の、 "GET /entities Fetch all entities"をクリックします。
- 展開されたコンテンツ内にある"Try it out"ボタンをクリックします。画面はインタラクティブにAPI呼び出しが行えるモードに入ります。
- "Execute"ボタンをクリックします。
- 画面更新が完了し、"Responses"にCodeが200、"Response body"にエンティティーのリストがJSONフォーマットで表示されれば成功です。