POST/api/public/access-request

提交某個套餐(Starter、個別設定或者14日 Demo)嘅存取申請。前提條件係事先已確認嘅電郵地址。

先透過`POST /api/public/access-request/email/start-verification`同`POST /api/public/access-request/email/verify`確認電郵地址。然後傳送`name`、同一個`email`、套餐`package`(`starter`、`individual`或者`demo_access`),以及收到嘅`verification_token`。可以選擇傳送`company`、`phone`、`companyWebsite`、`paymentMethod`(`paypal`、`kreditkarte`、`rechnung`、`stripe_card`或者`stripe_sepa`)、`wish`(`trial`、`subscription`或者`offer`;申請試用版存取時一定係`trial`),以及`message`。 如果冇有效確認,伺服器就會以400 `EMAIL_NOT_VERIFIED`回應。缺少必填欄位,或者套餐、付款方式、意向嘅值無效,就會導致400 `VALIDATION_ERROR`。每個成功嘅申請都會被重新建立並由 Zentor 處理,所以請唔要自動重試呢個呼叫。 每個IP地址最多15分鐘內10次請求。另外Zentor嘅存取規則(IP、國家同電郵域名規則)都適用;被拒絕嘅呼叫會收到403。

概覽

調用:POST /api/public/access-request。此端點屬於 Zentor App API 的「公開表單」組別。 此端點可公開存取,毋須身份驗證。 此調用並非冪等:每次成功調用均會再次觸發有關操作。 必填參數:name (請求主體), email (請求主體), package (請求主體)。 選填參數:company (請求主體), phone (請求主體), companyWebsite (請求主體), paymentMethod (請求主體), wish (請求主體), message (請求主體)。 已記錄的錯誤情況:400 VALIDATION_ERROR, 400 EMAIL_NOT_VERIFIED。 下方的範例回應展示 JSON 格式成功回應的結構。

身份驗證同安全保障

唔需要身份驗證

冪等: 唔係

參數

name(body, string,必填)— 姓名,2–120個字
email(body, string,必填)— 之前已經透過`/email/verify`確認嘅電郵地址
package(body, string,必填)— 套餐:`starter`、`individual`或者`demo_access`
company(body, string)— 公司,最多160個字(可選)
phone(body, string)— 電話號碼,最多40個字(可選)
companyWebsite(body, string)— 公司網站,最多200個字(可選)
paymentMethod(body, string)— 付款方式:`paypal`、`kreditkarte`、`rechnung`、`stripe_card`或者`stripe_sepa`(可選)
wish(body, string)— 意向:`trial`、`subscription`或者`offer`;`demo_access`嗰陣一定係`trial`(可選)
message(body, string)— 訊息,最多3000個字(可選)

請求範例

{"name":"陳大文","email":"max@example.com","package":"demo_access"}

回應範例

{"ok":false,"error":"EMAIL_NOT_VERIFIED","message":"Bitte bestätigen Sie zuerst Ihre E-Mail-Adresse."}

錯誤代碼

400 VALIDATION_ERROR — 必填欄位缺失,或者套餐、付款方式、意向無效。
400 EMAIL_NOT_VERIFIED — 電郵地址未事先透過`/email/start-verification`同`/email/verify`確認,或者`verification_token`缺失或者無效。

已驗證嘅行為

空請求體會回傳400 `VALIDATION_ERROR`;冇已確認電郵地址嘅有效資料就會回傳400 `EMAIL_NOT_VERIFIED`。成功情況遵循電郵確認之後嘅文件說明流程。

公開表單

POST /api/public/contact接收嚟自 Zentor App 網站聯絡表單嘅請求,並轉交畀 Zentor 團隊。POST /api/public/consultation接收嚟自 Zentor App 網站表單嘅咨詢請求。POST /api/public/access-request/email/start-verification向指定嘅電郵地址傳送一個有效期為10分鐘嘅六位數確認碼——呢個係存取申請嘅第一步。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啟用新建立嘅用戶帳戶,並設定第一個密碼——透過邀請電郵嘅連結啟動。

相關文章

← 公開表單