Skip to main content
Version: 2.8.1

API Key

用途說明#

使用 API金鑰做身份驗證。通常會搭配 ACL 使用。

欄位配置說明#

變數類型預設值說明必填
expired_daysnumber180金鑰可使用的有效時間(單位為天)。
金鑰創建時,會根據當下時間加上 expired_days 之設定天數來設定到期時間。
*注意:若修改此欄位,則已創建的金鑰並不會同步重置到期時間,影響的只有修改此欄位後,新創建的金鑰。

用法示例#

在全局啟用插件#

  1. 從網站左邊 Menu 中 外掛插件 頁面中,點選右上角的 新增外掛插件

全局啟用畫面

  1. 點選後,選擇 認證 頁籤,並啟用 Api Key,填寫內容參考欄位配置說明,設定成功後,後續才能夠創建、更新、刪除 API金鑰。
note

此插件在 GOC API Gateway 啟動服務時即會自動啟用。

驗證#

驗證方式請參考 ACL驗證