giip
SES 商機登記
2分鐘閱讀

Vercel 管理 API 指南 (v1.2)

GIIP 平台提供用於管理 Vercel 項目配置和查詢部署歷史記錄的 API。該 API 預設採用 Sk3 (基於 JSON 數據) 介面來處理請求。

🔌 前往 Vercel 狀態頁 →

📋 概述

Vercel 管理 API 用於查詢在 GIIP 中註冊的 Vercel 項目設置,或監控最新的部署歷史。

🔐 認證與安全

所有請求都必須包含 GIIP 通用身份驗證標頭。

  • 標頭 (Header): x-giip-ak, x-giip-sk
  • 請求體上下文 (Body Context): Sk3 介面(使用 jsondata 欄位)

📡 API 詳情 (Sk3)

1. 查詢 Vercel 配置清單 (VercelConfigsList)

  • 命令: text=VercelConfigsList
  • jsondata: {"csn": 123} (可選:項目標識符)
  • 說明: 返回目前註冊的所有 Vercel 配置資訊以及關聯的 Vercel 項目名稱。

2. 創建 Vercel 配置 (VercelConfigCreate)

  • 命令: text=VercelConfigCreate
  • jsondata:
{
  "csn": 123,
  "configName": "Production_Main",
  "vercelProjectName": "giip-next-app",
  "vercelToken": "vcl_token_...",
  "vercelTeamId": "team_xxx",
  "vercelProjectId": "prj_xxx"
}

3. 修改/刪除 Vercel 配置 (VercelConfigUpdate / VercelConfigDelete)

  • 修改: text=VercelConfigUpdate + {"vcId": 123, ...}
  • 刪除: text=VercelConfigDelete + {"vcSn": 123} (或 vcId)

4. 查詢部署歷史 (VercelDeploymentsList)

  • 命令: text=VercelDeploymentsList
  • jsondata: {"vcId": 123, "limit": 20}
  • 說明: 按時間倒序查詢對應特定配置 (vcId) 的 Vercel 部署清單。

🛡️ 巧用 Sk3 (高性能日誌)

Vercel 管理 API 從設計階段起就將 giipApiSk3 介面作為標準。它為所有配置管理和查詢請求提供詳細的執行上下文和錯誤追蹤。

  • 端點: https://giipfaw.azurewebsites.net/api/giipApiSk3
  • 優勢: 當發生 Vercel 令牌 (Token) 錯誤或部署狀態同步失敗時,會自動記錄調用者的 IP、User-Agent 以及詳細的服務端堆栈跟蹤 (StackTrace),幫助您迅速診斷集成問題。
  • 使用技巧: 在發送如 VercelConfigCreate 等包含大量參數的請求時,利用 jsondata 物件結構可以確保複雜的令牌值安全、完整地傳輸,並保留詳細日誌。

🔧 疑難排解

症狀原因解決
請求因認證錯誤被拒絕缺少 x-giip-ak / x-giip-sk 請求頭或金鑰錯誤包含有效的認證請求頭後重試
text 命令無法識別或返回空回應text 值拼寫錯誤(例如 VercelConfigListVercelConfigsList)確認準確的命令名並設定到 text 參數中
部署清單為空或同步失敗vercelToken 已過期或無效透過 VercelConfigUpdate 更新有效令牌後重新查詢
VercelDeploymentsList 無返回結果vcId 錯誤,或該配置無部署歷史使用 VercelConfigsList 確認正確的 vcId 後重試

版本: 1.3 最後更新: 2026-04-11 源碼: giipv3/public/help/api-vercel.zh-TW.md


相關文檔: