跳至正文
TurnitPass
開發者中心API v1管理金鑰
瀏覽文件

開發者API 金鑰

建立與輪替 Bearer 金鑰

金鑰在工作台中管理。本頁說明金鑰生命週期、安全模型,以及正式環境中的請求方式。

REST API v1

開發者平台

總覽

工作台
GET/api/v1/status
依帳戶隔離
狀態查詢範例
GET /api/v1/status
curl https://turnitpass.com/api/v1/status \
  -H "Authorization: Bearer tp_live_your_api_key"

說明

01

金鑰格式

建立時僅顯示一次,後續可在工作台中輪替。

02

儲存方式

首次顯示後將不再提供明文。

03

預設上限

正式、預發與本機金鑰應分開管理,請勿共用同一把金鑰。

金鑰生命週期

每個串接流程皆可遵循的維運週期

1

標明環境

以清晰名稱區分正式、預發或示範環境,方便閱讀用量紀錄。

2

僅複製一次

完整憑證僅在建立時顯示一次。請存入伺服器端環境變數,切勿寫入前端程式碼。

3

先查詢狀態

傳送內文前,先呼叫 GET /api/v1/status 確認金鑰、餘額與呼叫上限。

4

零中斷輪替

先建立新金鑰並完成部署上線,再至工作台撤銷舊金鑰。

安全性說明

金鑰系統運作機制

請求標頭
Authorization: Bearer API key所有 v1 路由皆採用一致的 Bearer 標頭格式。
儲存方式
靜態加密保護首次顯示後即加密儲存,後續不再傳回明文。
撤銷機制
立即生效撤銷後該金鑰即刻失效無法驗證,登入帳號與其他金鑰不受影響。
作用範圍
歸屬帳戶用量、字數、帳單與請求紀錄皆歸屬於當前工作台帳戶。
實作說明。 金鑰的建立與撤銷需在登入後的工作台中操作。公開文件僅說明流程,不包含金鑰明文。
下一步,把它接到你的工作流程。繼續閱讀