跳到內容

API 驗證

所有 Piora API 請求都需要驗證。Piora 使用 Bearer Token 進行 API 驗證。

  1. 登入 Piora 控制面板
  2. 進入「設定」>「API Token」
  3. 點選「產生新 Token」
  4. 為 Token 命名(例如 ci-cd-pipeline
  5. 選擇 Token 權限範圍
  6. 點選「建立」

產生 Token 時,你可以選擇以下權限範圍:

權限說明
servers:read讀取伺服器資訊
servers:write管理伺服器
applications:read讀取應用資訊
applications:write管理應用
applications:deploy部署應用
databases:read讀取資料庫資訊
databases:write管理資料庫
backups:read讀取備份資訊
backups:write管理備份

在每個 API 請求的 Authorization 標頭中加入 Token:

Terminal window
curl -X GET https://app.piora.dev/api/v1/servers \
-H "Authorization: Bearer piora_token_xxxxxxxxxxxx"
// Node.js (fetch)
const response = await fetch('https://app.piora.dev/api/v1/servers', {
headers: {
'Authorization': 'Bearer piora_token_xxxxxxxxxxxx',
'Content-Type': 'application/json',
},
});
const data = await response.json();
# Python (requests)
import requests
response = requests.get(
'https://app.piora.dev/api/v1/servers',
headers={'Authorization': 'Bearer piora_token_xxxxxxxxxxxx'}
)
data = response.json()
// Go
req, _ := http.NewRequest("GET", "https://app.piora.dev/api/v1/servers", nil)
req.Header.Set("Authorization", "Bearer piora_token_xxxxxxxxxxxx")
resp, _ := http.DefaultClient.Do(req)

在「設定」>「API Token」頁面可以查看所有已建立的 Token:

  • Token 名稱
  • 權限範圍
  • 建立日期
  • 最後使用時間

如果 Token 可能已外洩,請立即撤銷:

  1. 進入「設定」>「API Token」
  2. 找到目標 Token
  3. 點選「撤銷」
  4. 確認操作

撤銷後,使用該 Token 的所有請求會立即收到 401 Unauthorized 回應。

  1. 不要在程式碼中硬編碼 Token — 使用環境變數
  2. 不要在版本控制中提交 Token — 將 Token 加入 .gitignore
  3. 定期輪換 Token — 建議每 90 天更換
  4. 使用最小權限 — 只授予必要的權限範圍
  5. 監控使用情況 — 定期檢查 Token 的使用記錄
Terminal window
# 使用環境變數
export PIORA_API_TOKEN=piora_token_xxxxxxxxxxxx
# 在程式中使用
curl -H "Authorization: Bearer $PIORA_API_TOKEN" \
https://app.piora.dev/api/v1/servers
HTTP 狀態碼說明
401Token 無效或已過期
403Token 權限不足
429超過速率限制