生成短链
创建一条新的短链,支持自定义访问码、路由规则、过期时间等。
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
}