API 文档/短链管理

生成短链

创建一条新的短链,支持自定义访问码、路由规则、过期时间等。

POST/api/link/create生成短链

请求参数 (application/json)

字段类型必填说明
sourceLink
string必填原始链接
domain
string必填选择的域名
linkType
string可选短链类型:OY 普通短链、WL 微信外链、WMP 小程序链接
visitCode
string可选自定义访问码,不传则随机生成
rules
array可选路由规则列表
ruleId
integer (int64)可选规则 ID
routingType
string可选路由类型
matchRule
string可选匹配规则
url
string可选目标 URL
expireDate
string可选过期时间,不传则按套餐默认
jumpType
string可选跳转类型,仅微信外链有效
wxProgram
object可选微信小程序跳转配置,仅小程序短链有效
appId
string可选小程序 AppID
path
string可选小程序页面路径
query
string可选页面查询参数
envVersion
string可选小程序版本:release 正式版、trial 体验版、develop 开发版
programJumpType
string可选跳转方式:PLAINTEXT 明文、CIPHERTEXT 密文
authAccountId
integer (int64)可选授权账号 ID(密文跳转时必填)
wxCom
object可选企业微信跳转配置,仅微信外链且跳转企业微信时有效
acquisitionLink
string可选获客链接
suiteLinkId
integer (int64)可选授权获客链接 ID(授权模式必填)
pageTemplate
string可选跳转中间页模版
directJump
integer (int32)可选是否直接跳转 0 否 1 是
wx
object可选普通微信跳转配置,仅微信外链且跳转普通微信时有效
wxAccount
string可选普通微信账号
qrCodeUrl
string可选微信账号二维码
pageTemplate
string可选跳转中间页模版

响应字段

字段类型必填说明
code
string可选状态码,OK 表示成功
message
string可选提示信息
data
boolean可选是否创建成功
success
boolean可选请求是否成功
cURL
curl -X POST 'https://open.xnanlink.com/api/link/create' \
  -H 'Content-Type: application/json' \
  -H 'Token: YOUR_TOKEN' \
  -d '{
    "sourceLink": "https://www.example.com/page?id=123",
    "domain": "lxs.la",
    "linkType": "OY",
    "visitCode": "mycode"
  }'
JSON
{
  "code": "OK",
  "message": "成功",
  "data": true,
  "success": true
}