如何接入API？

鉴权

1. 使用 Token 鉴权

Authorization: Token {{USER_TOKEN}}

用户登录后台会自动生成 Token，注销登录后失效。

你可以 F12 打开浏览器开发者工具，刷新页面后，在 网络 一栏里任选 API 访问获得 Token。

API 列表

外部链接跳转小程序（推荐）

示例请求：

POST {{HOST}}/shortlink.ShortLinkService/CreateWxMpShortLink
Authorization: Token {{USER_TOKEN}}
Content-Type: application/json

{
  "appid": "wx5a8f481d967649eb",
  "path": "/pages/common/pay/appPay?orderNo=2016164960402407425&memberId=1758808571403065055&paymentId=2016165006948978690&payMethod=3&orderType=2",
  "title": "纷玩岛测试",
  "mode": 2
}

示例响应：

{
  "msg": "WxMp short link created successfully",
  "shortlink": "https://wx.knowuv.com/sl/23o8o"
}

• 计费规则

跳转小程序（极速版⚡️）

• 适用场景

该接口返回 base64 编码的长链接，直接跳转小程序。

适用于对 高并发、低延迟 有极高要求，对链接长度没有严格要求的场景。

• 请求示例

POST https://rpc.knowuv.com/shortlink.ShortLinkService/CreateWxMpShortLink
Authorization: Token {{USER_TOKEN}}
Content-Type: application/json

{
  "appid": "wx15f182efdb0ba66c",
  "path": "/pages/index/index",
  "title": "泡泡🫧马特测试 PopMart",
  "mode": 1
}

• 响应示例

{
  "msg": "WxMp fast short link created successfully",
  "shortlink": "https://wx.knowuv.com/jump-mp.html?data=eyJjaGVja1N1bSI6MjkzMTY5NDExNiwiZHN0QXBwSWQiOiJ3eDE1ZjE4MmVmZGIwYmE2NmMiLCJkc3RQYXRoIjoiL3BhZ2VzL2luZGV4L2luZGV4IiwibWVzc2FnZSI6IuazoeazofCfq6fpqaznibnmtYvor5UgUG9wTWFydCIsInRva2VuIjoiZTdiNzA0MmE1Mzg4YzZmMzFhYzRlYTkyNTlmZTY0OGYifQ"
}

• 计费规则

创建模版落地页

• 适用场景

该接口返回可自定义参数的模版落地页短链接。

适用于对用户体验、页面美观有要求的场景，用户可咨询管理员定制落地页。

• 示例请求

POST https://rpc.knowuv.com/shortlink.ShortLinkService/CreateLandingPageShortLink
Authorization: Token {{USER_TOKEN}}
Content-Type: application/json

{
  "templateName": "wxmp_gift",
  "urlQuery": {
    "appid": "wx15f182efdb0ba66c",
    "path": "/pages/index/index",
    "title": "泡泡🫧马特测试 PopMart",
    "description": "这是一大串描述信息，用于测试生成落地页短链接的功能是否正常工作。",
    "btn_text":    "去抽盒子🎉",
    "image": "https://nouv.oss-cn-shanghai.aliyuncs.com/_nuxt/imgs/img.png"
  }
}

• 示例响应

{
  "msg": "Landing Page short link created successfully",
  "shortlink": "https://wx.knowuv.com/sl/yaARm"
}

• 计费规则

创建微信小程序短链接

• 适用场景

该接口返回短链接，直接跳转小程序。

适用于需要快速对接的用户。

• 示例请求

POST https://rpc.knowuv.com/shortlink.ShortLinkService/CreateWxMpShortLink
Authorization: Token {{USER_TOKEN}}
Content-Type: application/json

{
  "appid": "wx15f182efdb0ba66c",
  "path": "/pages/index/index",
  "title": "泡泡🫧马特测试 PopMart"
}

• 示例响应

{
  "msg": "WxMp short link created successfully",
  "shortlink": "https://h5.knowuv.com/sl/2w3Fu"
}

• 计费规则

创建 MDC 短链接

MDC 是 Nuxt 基于 Markdown 拓展的语法，可以允许自定义页面。

优点是非常灵活，示例页面：https://h5.knowuv.com/sl/N3R6y

用法：

1. 进入 MDC 编辑器，编辑自己想要的页面
2. 把内容全选，传进 API 即可

路径： /shortlink.ShortLinkService/CreateMdcShortLink

• 适用场景

对性能没有严格要求，能够达到最大限度自定义的场景。

• 请求格式：

message CreateMdcShortLinkRequest {
  string mdcContent = 1;
  map<string, string> urlQuery = 2;
  int64 etime = 3;
}

message CreateMdcShortLinkResponse {
  int32 code = 1;
  string msg = 2;
  string shortlink = 3;
}

• 计费规则

创建跳转支付链接

• 使用场景：weixin://xxxx

请求示例：

POST https://rpc.knowuv.com/shortlink.ShortLinkService/CreateShortLinkV2
authorization: Token {{USER_TOKEN}}
Content-Type: application/json

{
  "originLinkList": [
    {
      "url": "weixin://wxpay/bizpayurl?pr=xxx",
      "weight": 100,
      "title": "跳转支付"
    }
  ],
  "domain": "wx.knowuv.com",
  "templateName": "中间页跳转"
}

响应示例：

{
  "msg": "Short link created successfully",
  "data": {
    "pk": "199101",
    "originLinkList": [
      {
        "url": "weixin://wxpay/bizpayurl?pr=xxx",
        "weight": 100,
        "title": "跳转支付",
        "Id": "000000000000000000000000",
        "hash": "f11a5c677155a71fcdd083829e39c401a3f6c0cb6a302236f88d8c13b0f5ebeb"
      }
    ],
    "status": 5,
    "domain": "wx.knowuv.com",
    "Id": "ObjectID(\"000000004ddf82fdc5860acb\")",
    "ctime": "1769945744526",
    "mtime": "1769945744526",
    "code": "Cqmn3",
    "userId": "1",
    "templateName": "中间页跳转"
  }
}

最后串起来：https://{domain}/sl/{code}，即可访问。

联系方式

• 邮箱📮： dusty-cjh@qq.com
• 微信🌟： dusty_cjh
• 电话📱： 13780359572

附录

• Swagger 文档 - 完整 proto 定义