POST/api/public/access-request/email/start-verification
向指定嘅電郵地址傳送一個有效期為10分鐘嘅六位數確認碼——呢個係存取申請嘅第一步。
將要確認嘅地址傳送到`email`欄位。回應會包含`verification_id`、`expires_in_minutes`(10)同`resend_cooldown_seconds`(60)。將`verification_id`同一樣嘅電郵地址,以及收到嘅代碼一齊用於`POST /api/public/access-request/email/verify`。只有等候時間結束之後先可以重新傳送;請喺您嘅界面顯示剩餘時間。 如果超出限制,端點就會以429 `RATE_LIMIT_EXCEEDED`回應。如果電郵冇辦法傳送,就會以502 `MAIL_NOT_SENT`回應;到時候請檢查地址,之後再試一次。
概覽
調用:POST /api/public/access-request/email/start-verification。此端點屬於 Zentor App API 的「公開表單」組別。 此端點可公開存取,毋須身份驗證。 此調用並非冪等:每次成功調用均會再次觸發有關操作。 必填參數:email (請求主體)。 已記錄的錯誤情況:429 RATE_LIMIT_EXCEEDED, 502 MAIL_NOT_SENT。 下方的範例回應展示 JSON 格式成功回應的結構。
身份驗證同安全保障
唔需要身份驗證
每個IP地址最多15分鐘內10次請求。另外,Zentor嘅存取規則(IP、國家同電郵域名規則)都適用;被拒絕嘅呼叫會收到403。
速率限制: 10 Anfragen pro 15 Minuten (IP-basiert)
冪等: 唔係
參數
email(body, string,必填)— 要確認嘅電郵地址請求範例
{"email":"max@example.com"}回應範例
{"ok":true,"verification_id":"<UUID>","expires_in_minutes":10,"resend_cooldown_seconds":60}錯誤代碼
429 RATE_LIMIT_EXCEEDED — 呢個IP地址發出嘅請求太多。請等一陣先申請新代碼。502 MAIL_NOT_SENT — 冇辦法透過電郵傳送確認碼。已驗證嘅行為
呢個呼叫會回傳200,並附帶`verification_id`,驗證碼會透過電郵傳送;重複呼叫就會回傳429 `RATE_LIMIT_EXCEEDED`。
公開表單
POST /api/public/contact接收嚟自 Zentor App 網站聯絡表單嘅請求,並轉交畀 Zentor 團隊。POST /api/public/consultation接收嚟自 Zentor App 網站表單嘅咨詢請求。POST /api/public/access-request提交某個套餐(Starter、個別設定或者14日 Demo)嘅存取申請。前提條件係事先已確認嘅電郵地址。POST /api/public/access-request/email/verify核實電郵發出嘅代碼,並為之後嘅存取申請發出確認權杖。GET /api/public/access-request/payment-status指出目前存取申請可以用嘅付款方式(PayPal、Stripe)。GET /api/public/access-request/paypal/config回傳付款步驟所需嘅公開 PayPal 設定(啟用狀態、模式、貨幣)。POST /api/public/access-request/paypal/create-order為所選套餐建立一個 PayPal 訂單。POST /api/public/access-request/paypal/capture-order完成(捕獲)之前建立並由買家喺 PayPal 結帳頁面批准嘅訂單。金額只由伺服器決定。POST /api/public/access-request/stripe/create-checkout為所選套餐建立一個 Stripe 結帳會話。POST /api/public/activate-account啟用新建立嘅用戶帳戶,並設定第一個密碼——透過邀請電郵嘅連結啟動。