快速入門
所有端點都係由單一基礎 URL 提供。每個要求都需要你嘅 API 密鑰x-api- 密鑰標題同 JSON 請求使用Content-Type: application/json.
底座 URL
https://cpt.cx
必需嘅標題
x-api-key: YOUR_API_KEY Content-Type: application/json
建立一個短連結
curl -X POST "https://cpt.cx/shortlink/public-generate" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "BBC News",
"url": "https://www.bbc.com/news",
"domain": "cpt.cx",
"tags": ["News", "BBC"]
}'認證
每個公共端點都會用一個 API 密鑰嚟驗證x-api- 密鑰標題。密鑰嘅作用域包括你嘅帳戶、針對佢註冊嘅網域同埋為你嘅頻道設定嘅供應商。將密鑰當成秘密 — 千祈唔好將佢哋嵌入用戶端代碼。
必需嘅標題
x-api-key: YOUR_API_KEY
URL 短鏈接 API
喺你帳戶註冊嘅任何網域 上面建立品牌 URL 短連結。用單一端點嚟做一個連結，或者用批次端點嚟喺一個請求入面產生好多 — 非常適合 SMS 、 RCS 、 WhatsApp 同埋電郵廣告系列。
POST/shortlink/public-generate
建立一個短連結要求正文
name— 字串，必須url— 字串，必須，必須使用http或者httpsdomain— 字串，必須，必須係註冊到你帳戶嘅網域tags— 字串陣列，可選username/password— 可選，必須以一對形式提供，以便用密碼保護連結
要求
{
"name": "BBC News",
"url": "https://www.bbc.com/news",
"domain": "cpt.cx",
"tags": ["News", "BBC"]
}200 OK
{
"name": "BBC News",
"shortUrl": "https://cpt.cx/RRRRRF",
"createdDate": "2025-07-02T15:38:02.95Z",
"expiryDate": "2025-08-01T15:38:02.95Z"
}預設到期日係喺建立之後30日。
POST/shortlink/public-generate-batch
批量建立 URL 短鏈接傳送一個短連結對象嘅 JSON 陣列。每個項目都會用同單一建立端點相同嘅欄位同驗證規則。呢個回應包含每個輸入項目嘅摘要同埋結果。
要求
[
{
"name": "BBC News",
"url": "https://www.bbc.com/news",
"domain": "cpt.cx"
},
{
"name": "Facebook",
"url": "https://www.facebook.com",
"domain": "cpt.cx",
"tags": ["News", "World"]
}
]200 OK
{
"summary": { "successCount": 2, "failedCount": 0 },
"results": [
{
"name": "BBC News",
"shortUrl": "https://cpt.cx/RRRRRT",
"createdDate": "2025-07-02T15:42:05Z",
"expiryDate": "2025-08-01T15:42:05Z"
},
{
"name": "Facebook",
"shortUrl": "https://cpt.cx/RRRRRa",
"createdDate": "2025-07-02T15:42:05Z",
"expiryDate": "2025-08-01T15:42:05Z"
}
]
}OTP API
為 SMS 或者電郵傳送生成一次性密碼，然後用退回嘅密碼驗證otpId。 API 永遠唔會返回 OTP 值 — 佢會傳送畀收件人，並且只會儲存為同 TTL 嘅哈希值。
POST/otp/generate
生成一個 OTP要求正文
channel— 需要，email或者smsprovider— 需要，供應商喺你嘅帳戶上面為嗰個頻道設定咗（例如generic,twilio,sendgrid)destination— 需要，電郵地址或者 E.164電話號碼type— 需要，numeric或者alphanumericlength— 需要，喺4至12之間expiresInSeconds— 需要，一定要大過0
要求
{
"channel": "email",
"provider": "generic",
"destination": "test@example.com",
"type": "alphanumeric",
"length": 8,
"expiresInSeconds": 300
}200 OK
{
"otpId": "51a6fcc7-efc8-4e69-8bc1-ebb999befb2c",
"destination": "test@example.com",
"createdAt": "2025-09-10T14:05:41Z",
"expiresAt": "2025-09-10T14:10:41Z"
}POST/otp/validate
驗證一個 OTP發送個otpId由返嚟/otp/generate同埋用戶提供嘅 OTP 值。成功驗證會消耗 OTP — 代碼係一次性嘅。
要求
{
"otpId": "c4f8814c-7a9d-4e13-b7d8-d4e66d272611",
"otp": "z4dGyBPQ"
}200 OK
{
"success": true,
"message": "OTP validated successfully."
}多次嘗試失敗之後，驗證會返回太多失敗嘅嘗試。遲啲再試。直到臨時鎖到期為止。
錯誤同埋已知嘅缺口
驗證錯誤會用描述性訊息返回，例如URL 格式無效。或者搵唔到呢個客戶端同頻道嘅供應商。。以下詳情仲未公開記錄 — 將佢哋視為 TODO ，如果你需要一個確定嘅答案嚟生產用途，請聯絡我哋：
- 認證失敗有效負載同埋精確嘅4xx/5xx 响應形狀
- 每個端點同每個帳戶嘅速率限制
- 建立短連結嘅最大批次大小
- 部分成功批次入面嘅每個項目失敗結構
- 短連結到期日係咪可以自訂超過預設30日
- 多次失敗嘗試後， OTP 暫時鎖定持續時間
機器可讀嘅資產
AI 代理、 LLM 爬蟲、 API 用戶端生成同技術發現嘅檔案。由網站嘅 HTML 頭同 robots . txt 連結，以便可靠地發現。