# 获取加密scheme码

调试工具

接口应在服务器端调用，详细说明参见服务端API。

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

# 接口说明

# 接口英文名

generateScheme

# 功能描述

• 该接口用于获取小程序 scheme 码，适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景。目前仅针对国内非个人主体的小程序开放，详见获取 URL scheme。

# 注意事项

# 调用上限

• 生成端：每天生成 URL Scheme（加密 明文） 和 URL Link 的总数量上限为50万
• 打开端：每天通过 URL Scheme（加密 明文） 和 URL Link 打开小程序的总次数上限为300万
• 自 2023 年 12 月 19 日起，取消 URL Scheme 一人一链的限制，支持同一条连接被多名用户访问。详细调整说明可见《URL Scheme 和 URL Link优化公告》。

# 其他注意事项

• 加密 URL Scheme 支持开发者自行在链接后面拼接 query 参数，详见获取 URL Scheme
• 微信内的网页如需打开小程序请使用微信开放标签-小程序跳转按钮，无公众号也可以直接使用小程序身份开发网页并免鉴权跳转小程序，见云开发静态网站跳转小程序。符合开放范围的小程序可以下发支持打开小程序的短信
• 该功能基本覆盖当前用户正在使用的微信版本，开发者无需进行低版本兼容
• 只能生成已发布的小程序的 URL Scheme
• 通过 URL Scheme 跳转到微信时，可能会触发系统弹框询问，若用户选择不跳转，则无法打开小程序。请开发者妥善处理用户选择不跳转的场景
• 部分浏览器会限制打开网页直接跳转，可参考示例网页设置跳转按钮

# 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/generatescheme?access_token=ACCESS_TOKEN 

# 云调用

• 出入参和HTTPS调用相同，调用方式可查看云调用说明文档

• 接口方法为: openapi.urlscheme.generate

# 第三方调用

• 调用方式以及出入参和HTTPS相同，仅是调用的token不同

• 该接口所属的权限集id为：88、115

• 服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

# 请求参数

# 返回参数

# 调用示例

示例说明: HTTPS请求

# 请求数据示例

{
    "jump_wxa":
    {
        "path": "/pages/publishHomework/publishHomework",
        "query": "",
        "env_version": "release"
    },
    "is_expire":true,
    "expire_type":1,
    "expire_interval":1
} 

# 返回数据示例

{
 "errcode": 0,
 "errmsg": "ok",
 "openlink": Scheme,
} 

示例说明: 云函数调用

# 请求数据示例

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.urlscheme.generate({
        "jumpWxa": {
          "path": '/pages/publishHomework/publishHomework',
          "query": ''
        },
        "isExpire": true,
        "expireTime": 1606737600
      })
    return result
  } catch (err) {
    return err
  }
} 

# 返回数据示例

{
 "errcode": 0,
 "errmsg": "ok",
 "openlink": Scheme,
} 

# 错误码