API 存取

WallaWhats 透過 JSON HTTP API 揭露與儀表板相同的操作。使用它來腳本化訂閱管理、將通知歷史拉入您自己的系統或將提醒與內部工具整合。每個付費層都包含 API 存取 — 請參閱 管理方案 了解每個方案的金鑰限制。

步驟 1 — 開啟 API 金鑰

在側邊欄中,點擊 API 金鑰(在 存取金鑰 下)。

步驟 2 — 建立金鑰

1. 點擊 建立金鑰。
2. 給金鑰一個 名稱(例如 production-server、local-dev)。名稱只是一個標籤 — 不影響權限。
3. 點擊 建立。

金鑰的完整值僅顯示 一次 — 立即將其複製到您的密碼管理器。WallaWhats 僅儲存一個雜湊加上一個短前綴(bws_xxxxxxxx…),因此以後無法復原。

像對待密碼一樣對待金鑰

擁有金鑰的任何人都可以在您的帳號上行動。將金鑰儲存在密碼管理器中,永遠不要將它們提交到 git,並定期輪換。

步驟 3 — 使用金鑰

在每個請求的 x-api-key 標頭中傳送金鑰:

curl -H "x-api-key: bws_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  https://api.wallawhats.com/subscriptions

可用的端點、請求主體和回應格式記錄在 API 參考 中。

步驟 4 — 輪換或撤銷

• 輪換 — 建立一個新金鑰,部署它,然後刪除舊金鑰。設計上沒有「輪換」按鈕;建立-然後-刪除使切換原子化。
• 撤銷 — 點擊金鑰列旁邊的 刪除。金鑰立即停止工作。任何正在進行的使用它的請求都會返回 401 Unauthorized。

方案限制

方案	API 金鑰
Free	1
Pro	1
Pro+	2
Business	5
Enterprise	20

如果達到限制,建立金鑰 將被停用 — 先刪除舊金鑰或升級您的方案。

下一步

對於請求/回應模式和完整的端點列表,請參閱 API 參考 →