Open API
短链接
使用 API 密钥认证创建短链接
概述
/api/v1/links/create 接口允许用户使用 API 密钥认证以编程方式创建短链接。
您可以在 短链接 API 体验平台 中尝试 API 接口。
认证方式
使用 API 密钥有两种方式:
-
授权请求头(推荐):
使用 API 密钥认证创建短链接
/api/v1/links/create 接口允许用户使用 API 密钥认证以编程方式创建短链接。
您可以在 短链接 API 体验平台 中尝试 API 接口。
使用 API 密钥有两种方式:
授权请求头(推荐):
Authorization: Bearer YOUR_API_KEY查询参数:
?key=YOUR_API_KEY频率限制会根据您的订阅等级自动配置:
POST /api/v1/links/create{
"slug": "my-link",
"targetUrl": "https://example.com",
"domain": "ig.do",
"visible": false,
"active": true,
"expiration": "-1",
"password": "123456",
"description": "我的短链接",
"tag"
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
slug | string | 是 | URL 短标识(3-100 字符,字母数字、连字符、下划线) |
targetUrl | string | 是 | 目标 URL(必须是有效的 URL) |
domain | string | 是 | 短链接使用的域名 |
visible | boolean | 否 | 链接是否在公开列表中可见(默认:false) |
active | boolean | 否 | 链接是否激活(默认:true) |
expiration | string | 否 | 过期设置(默认:"-1" 表示永不过期) |
password | string | 否 | 6 字符密码用于链接保护 |
description | string | 否 | 链接描述(最多 500 字符) |
tag | string | 否 | 用于分类的标签(最多 50 字符) |
对域名的访问权限基于您的订阅等级:
ig.do):所有用户可用kfc.sh、uv.do):需要专业订阅或终身计划如果您尝试在没有适当订阅的情况下使用专业域名,将收到 403 错误。
{
"success": true,
"data": {
"id": "abc123xyz",
"slug": "my-link",
"targetUrl": "https://example.com",
"domain": "ig.do",
"shortUrl": "https://ig.do/my-link",
"visible": false,
"active":
{
"success": false,
"error": "Missing API key. Provide it via Authorization header (Bearer token) or ?key= query parameter"
}{
"success": false,
"error": "Invalid or expired API key: [error details]"
}{
"success": false,
"error": "Invalid request data",
"details": [
{
"path": ["slug"],
"message": "Slug must be at least 3 characters"
}
]
}{
"success": false,
"error": "You don't have permission to use the domain \"kfc.sh\". Premium domains require an active Pro subscription or Lifetime plan."
}{
"success": false,
"error": "A link with this slug already exists"
}curl -X POST https://your-domain.com/api/v1/links/create \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"slug": "example",
"targetUrl": "https://example.com",
"domain": "ig.do"
}'const response = await fetch('https://your-domain.com/api/v1/links/create', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
slug:
import requests
url = 'https://your-domain.com/api/v1/links/create'
headers = {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
}
data =
.env 文件或安全保险库中channel: "api" 以便跟踪api、admin、dashboard)不能用作 slug