微信小程序
获取 Short Link
# 获取ShortLink
调试工具
接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >= 1.02.1904090
(最新稳定版下载),wx-server-sdk
>= 0.4.0
# 接口说明
# 接口英文名
generateShortLink
# 功能描述
获取小程序 Short Link,适用于微信内拉起小程序的业务场景。目前只开放给电商类目(具体包含以下一级类目:电商平台、商家自营、跨境电商)。通过该接口,可以选择生成到期失效和永久有效的小程序短链,详见获取 Short Link。
# 注意事项
# 调用上限
Link 将根据是否为到期有效与失效时间参数,分为 短期有效ShortLink 与 永久有效ShortLink:
- 单个小程序每日生成 ShortLink 上限为100万个(包含短期有效 ShortLink 与长期有效 ShortLink )
- 单个小程序总共可生成永久有效 ShortLink 上限为10万个,请谨慎调用。
- 短期有效ShortLink 有效时间为30天,单个小程序生成短期有效ShortLink 不设上限。
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/genwxashortlink?access_token=ACCESS_TOKEN
# 云调用
出入参和HTTPS调用相同,调用方式可查看云调用说明文档
接口方法为: openapi.shortlink.generate
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:88、115
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
# 返回参数
# 调用示例
示例说明: HTTPS请求
# 请求数据示例
{
"page_url": "/pages/publishHomework/publishHomework?query1=q1",
"page_title": "Homework title",
"is_permanent":false
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"link": "Short Link"
}
示例说明: 云函数调用
# 请求数据示例
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.shortlink.generate({
"pageUrl": '/pages/publishHomework/publishHomework?query1=q1',
"pageTitle": 'Homework title',
"isPermanent": false
})
return result
} catch (err) {
return err
}
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"link": "Short Link"
}