(10.3.0-ja) (10.2.0-ja) API トークン
概要
外部 API トークン管理ページでは、管理者がウェブコンソールを超えて外部から QueryPie の機能にアクセスするための API トークンを発行・管理することができます。
外部 APIとは
QueryPie の外部 API は、Web コンソールの外部で QueryPie の機能を利用できるようにするものです。バージョン 10.0の時点で、QueryPie は2つの API バージョンを提供しています：V0.9 と V2 です。
QueryPie API V2
QueryPie バージョン 9.16.1からサポート。
API V0.9に影響を与えることなく、
{querypie url}/api/external/v2/経由でアクセス可能。
API 呼び出しに必要なヘッダは以下の通り：
キー | 値 |
|---|---|
コンテンツタイプ | application/json |
認証 | {QueryPie API トークン}。 |
API トークン使用上の注意事項
API トークンは、Owner 権限を持つユーザー、またはこのメニューにアクセスできる管理者のみが発行できます。
完全なトークンは発行時のみ表示されます。それ以降はマスクされ、最初の 8文字のみが表示される。
トークンを紛失した場合は、既存のトークンを削除し、新しいトークンを発行することをお勧めします。
API トークンの有効期限を延長すると、更新時から選択された有効期間に基づいて有効期限がリセットされます。
利用可能なAPIの完全なリストと詳細な仕様については、管理者 > 一般 > システム > APIトークンメニューの API Docs をクリックしてアクセスできるAPIドキュメントを参照してください。
API トークンのリストの表示
[管理者] > [全般] > [システム] > [API トークン] メニューに移動します。
現在生成されているトークンのリストを、作成日順（最新のものから）に表示します。
検索とフィルタ：
トークン名またはトークン値でトークンを検索します。トークンのステータスでリストをフィルタします。
API トークンの作成
ページの右上にある
Create API Tokenボタンをクリックします。以下の情報を入力します
API Name（API名）: API トークンの一意の識別可能な名前。
有効期間タイプ: トークンの有効期限を設定します。
セキュリティ上、"Never Expire "は選択しないことを推奨します。
スコープ: APIトークンの権限を設定します。
フルアクセス: すべての管理者権限を付与します。
ロールを選択します: トークンのアクセス範囲を制限する特定の管理者ロールを選択します。
管理者ロールを選択せずにトークンを保存することもできます。この場合、API トークンはアクションを実行できません。
許可ゾーン：API トークンを使用できるIP範囲を定義します。
Admin > General > Company Management > Allowed Zones に移動し、API コールの IP ACL を構成するために定義済みの Allowed Zones をマッピングします。
Description: API トークンの説明を入力します。
OKをクリックして作成プロセスを完了します。トークンの詳細がモーダルで表示されます。トークンの完全な値が表示されるのはこの時だけです。
一般設定 > システム > API トークン > API トークンの作成コピーボタンをクリックして、トークン情報をコピーします。
OKをクリックして、モーダルを閉じます。
API トークンの編集
トークンリストで、編集するトークンをクリックします。
API トークンの編集モーダルが表示され、以下の内容を変更できます。
API名: 必要に応じて名前を更新します。
有効期間タイプ:トークンの有効期限を変更します。
新しい日付は、現在の設定に基づいて以前の有効期限を上書きします。
API トークンの有効期限が切れるまでの残り時間が、新しく指定した有効期限より短くても長くても、有効期限は新しく設定された値で上書きされます。これにより、状況に応じて API トークンの有効期限を延長したり短縮したりすることができます。
Never Expire を選択すると、有効期限が削除されます。ただし、これは推奨されません。
スコープ: API トークンが持つ権限を変更します。
フルアクセス: すべての管理者権限を付与します。
ロールを選択します: 特定の管理者ロールを選択して、トークンのアクセス範囲を制限します。
管理者ロールを選択せずにトークンを保存することもできます。この場合、API トークンはアクションを実行できません。
許可ゾーン: API トークンを使用できるIP範囲を定義します。
管理] > [全般] > [会社管理] > [許可ゾーン] に移動し、定義済みの許可ゾーンをマッピングして API コール IP ACL を構成します。
説明: 必要に応じて説明を更新します。
OKをクリックして変更を保存します。
API トークンの更新
API トークンのページで、更新したいトークンを探し、
Updateボタンをクリックします。更新に成功すると、トースト通知が表示され、有効期間タイプの設定に基づいてトークンの有効期限が延長されます。
APIトークンの削除
API トークンのページで、削除したいトークンをチェックボックスで選択します。
テーブルヘッダの
削除ボタンをクリックします。OKボタンをクリックして、ポップアップで削除を確認します。トークンがリストから削除されたことを確認します。