CreateYourVPN Academy
合作夥伴 API

合作夥伴 API

面向合作夥伴的伺服器 API:透過您自己的網站或機器人建立客戶、發放方案並管理訂閱。

合作夥伴 API 讓您可以在 CreateYourVPN 上建立自己的網站、客戶入口網站或機器人。API 只公開客戶、方案與訂閱;伺服器、節點、面板以及基礎設施憑證絕不會出現在回應中。

金鑰僅供伺服器之間通訊使用。 切勿將它放入 JavaScript 或行動應用程式。看似來自瀏覽器的請求會以 403 browser_forbidden 拒絕。

開始使用

  1. 在控制台中開啟 設定 → API 與整合
  2. 以最小權限建立金鑰並複製 secret;它只會顯示一次。
  3. 透過 Authorization: Bearer cyv_live_…X-API-Key 傳送金鑰。
curl https://api.createyourvpn.com/api/v1/partner-api/me \
  -H "Authorization: Bearer cyv_live_<key_id>_<secret>"

權限:config:read 用於設定與地點,users:read 用於讀取客戶,users:write 用於建立客戶與管理訂閱。

公開契約

公開 Postman 集合包含所有端點、參數、請求本文、範例、權限與錯誤代碼。它由後端契約產生,因此是唯一的技術參考。

限制:每個金鑰每分鐘 120 個請求,GET /users 每分鐘 10 個請求。grantrotateDELETE 必須提供 Idempotency-Key;同一事件的所有重試應在 24 小時內重複使用相同值。

On this page