API Service 範本

最後更新: 4 Jul 2026

選用官方 IT 套件—API Service 結構化欄位。

此範本是什麼

API Service 範本用於機器對機器憑證用的 API 金鑰、權杖與 Webhook 端點。於 設定 → 分類範本 → 基礎設施與 IT 啟用。

分類 slugapi-service
套件選用官方 — nt2-template-api-service
方案免費

何時使用(與何時不用)

適合情境

  • 測試與正式環境的 REST/GraphQL API 金鑰
  • 與人類登入密碼分開存放的 Webhook 簽章密鑰
  • 每個廠商或微服務端點各一項目

請改用其他範本

情境較適合的範本
人員入口網站登入Credential
主機 SSH 金鑰對SSH Key
非結構化運維筆記Secure Note

日常流程

  • 啟用分類範本套件 → 基礎設施與 IT 啟用 API Service
  • 依環境(prod/staging)各建一項,並用 environment保管箱標籤分類。
  • 輪替憑證時以 30 秒自動清除 複製 API key

欄位一覽

欄位填什麼敏感?
TitleTitle
Service nameService name
Endpoint URLEndpoint URL
API keyAPI key
Webhook URLWebhook URL
EnvironmentEnvironment
NotesNotes

你需要什麼

方案免費
保管箱狀態已解鎖
網路首次成功載入後可離線
功能開關API Service 套件已啟用—見啟用分類範本套件

步驟

  1. 解鎖保管箱,開啟 設定 → 一般 → 分類範本
  2. 基礎設施與 ITAPI Service 切換為 開啟
  3. 開啟 資產新增資產API Service
  4. 填寫必填欄位並 儲存

提示與常見錯誤

  • 先啟用套件—API Service 非核心內建。
  • 勿將密鑰貼進 Secure Note—會失去遮罩、驗證與共用封鎖。
  • 複製密鑰後剪貼簿 30 秒自動清除—請盡快貼上。

相關連結