# 获取加密scheme码

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：generateScheme

- 该接口用于获取小程序 scheme 码，适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景。目前仅针对国内非个人主体的小程序开放，详见[获取 URL scheme](/miniprogram/dev/framework/open-ability/url-scheme.md)。

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 调用方法：urlscheme.generate

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：88

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/minigame/dev/api-backend/access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "jump_wxa",
    "类型": "object",
    "必填": "否",
    "说明": "跳转到的目标小程序信息。"
  },
  {
    "参数名": "expire_time",
    "类型": "number",
    "必填": "否",
    "说明": "到期失效的 scheme 码的失效时间，为 Unix 时间戳。生成的到期失效 scheme 码在该时间前有效。最长有效期为30天。is_expire 为 true 且 expire_type 为 0 时必填"
  },
  {
    "参数名": "expire_type",
    "类型": "number",
    "必填": "否",
    "说明": "默认值0，到期失效的 scheme 码失效类型，失效时间：0，失效间隔天数：1"
  },
  {
    "参数名": "expire_interval",
    "类型": "number",
    "必填": "否",
    "说明": "到期失效的 scheme 码的失效间隔天数。生成的到期失效 scheme 码在该间隔时间到达前有效。最长间隔天数为30天。is_expire 为 true 且 expire_type 为 1 时必填"
  }
]
```

### Body.jump_wxa `Object Payload`

跳转到的目标小程序信息。

```json
[
  {
    "参数名": "path",
    "类型": "string",
    "必填": "否",
    "说明": "通过 scheme 码进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query。path 为空时会跳转小程序主页。"
  },
  {
    "参数名": "query",
    "类型": "string",
    "必填": "否",
    "说明": "通过 scheme 码进入小程序时的 query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符：\u0000INLINECODE_3\u0000`"
  },
  {
    "参数名": "env_version",
    "类型": "string",
    "必填": "否",
    "说明": "默认值\"release\"。要打开的小程序版本。正式版为\"release\"，体验版为\"trial\"，开发版为\"develop\"，仅在微信外打开时生效。"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "openlink",
    "类型": "string",
    "说明": "生成的小程序 scheme 码"
  }
]
```

## 4. 注意事项

#### 调用上限
- 生成端：每天生成 URL Scheme（加密+明文） 和 URL Link 的总数量上限为50万
- 打开端：每天通过 URL Scheme（加密+明文） 和 URL Link 打开小程序的总次数上限为300万
- **自 2023 年 12 月 19 日起，取消 URL Scheme  一人一链的限制，支持同一条连接被多名用户访问。详细调整说明可见[《URL Scheme 和 URL Link优化公告》](https://developers.weixin.qq.com/community/develop/doc/00024e32cbc36055c0c0a34b066401)。**

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

## 5. 代码示例

### 5.1 HTTPS请求

请求示例

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

返回示例

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

### 5.2 云函数调用

请求示例

```json
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
  }
}
```

返回示例

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

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "40001",
    "错误描述": "invalid credential  access_token isinvalid or not latest",
    "解决方案": "获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口"
  },
  {
    "错误码": "40002",
    "错误描述": "invalid grant_type",
    "解决方案": "暂无生成权限（个人主体小程序无权限，或者NFC 能力的小程序未申请权限）"
  },
  {
    "错误码": "40013",
    "错误描述": "invalid appid",
    "解决方案": "生成权限被封禁"
  },
  {
    "错误码": "40165",
    "错误描述": "invalid weapp pagepath",
    "解决方案": "参数path填写错误，更正后重试"
  },
  {
    "错误码": "40212",
    "错误描述": "invalid query",
    "解决方案": "参数query填写错误\t，query格式遵循URL标准，即k1=v1&k2=v2"
  },
  {
    "错误码": "44990",
    "错误描述": "reach max api second frequence limit",
    "解决方案": "频率过快，超过100次/秒；降低调用频率"
  },
  {
    "错误码": "44993",
    "错误描述": "reach max api day frequence limit",
    "解决方案": "单天生成加密 URL Scheme+URL Link 数量超过上限50万"
  },
  {
    "错误码": "85079",
    "错误描述": "miniprogram has no online release",
    "解决方案": "小程序没有线上版本，即小程序尚未发布，不可进行该操作"
  },
  {
    "错误码": "85401",
    "错误描述": "time limit between 1min and 30days",
    "解决方案": "参数expire_time填写错误，时间间隔大于1分钟且小于30天，更正后重试"
  },
  {
    "错误码": "85402",
    "错误描述": "invalid env_version",
    "解决方案": "参数env_version填写错误，更正后重试"
  },
  {
    "错误码": "85406",
    "错误描述": "daily visit  limit",
    "解决方案": "URL Scheme（加密+明文）/加密 URL Link 单天累加访问次数超过上限"
  },
  {
    "错误码": "85407",
    "错误描述": "no scheme permission",
    "解决方案": "暂无生成权限"
  },
  {
    "错误码": "85408",
    "错误描述": "appid banned",
    "解决方案": "生成权限被封禁"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "小程序": "✔",
    "小游戏": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。