快速入门
所有端点均由单一基础 URL 提供服务。每个请求都需要您的 API 密钥x-api-密钥header 和 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。 OTP 值永远不会由 API 返回 - 它被传递给接收者并仅存储为带有 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 进行链接，以实现可靠的可发现性。