# 获取NFC的小程序scheme

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

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

接口英文名：generateNFCScheme

该接口用于获取用于 NFC 的小程序 scheme 码，适用于 NFC 拉起小程序的业务场景。目前仅针对国内非个人主体的小程序开放，详见 [NFC 标签打开小程序](/miniprogram/dev/framework/open-ability/NFC.md)。

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 调用方法：urlscheme.generateNFCScheme

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

### 第三方调用

- 本接口不支持第三方平台调用。

## 2. 请求参数

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

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "jump_wxa",
    "类型": "object",
    "必填": "否",
    "说明": "跳转到的目标小程序信息。"
  },
  {
    "参数名": "model_id",
    "类型": "string",
    "必填": "是",
    "说明": "scheme对应的设备model_id"
  },
  {
    "参数名": "sn",
    "类型": "string",
    "必填": "否",
    "说明": "scheme对应的设备sn，仅一机一码时填写"
  }
]
```

### Body.jump_wxa `Object Payload`

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

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

## 3. 返回参数

### 返回体 `Response Payload`

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

## 4. 注意事项

# 调试

通过开发者工具的”快速 URL Schema编译“可以调试生成的 URL Schema

![](https://res8.wxqcloud.qq.com.cn/wxdoc/1f0b0493-b5d5-4fe9-8987-2a0c5abea3e2.png)

## 5. 代码示例

请求示例

```json
{
  "jump_wxa": {
    "path": "/pages/publishHomework/publishHomework",
    "query": ""
  },
  "sn": "xxx",
  "model_id": "xxx"
}
```

返回示例

```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
[
  {
    "错误码": "40002",
    "错误描述": "暂无生成权限（非个人主体小程序无权限，未申请 NFC 能力的小程序无权限）",
    "解决方案": ""
  },
  {
    "错误码": "40013",
    "错误描述": "生成权限被封禁",
    "解决方案": ""
  },
  {
    "错误码": "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",
    "解决方案": "单天生成Scheme+URL Link数量超过上限50万"
  },
  {
    "错误码": "85079",
    "错误描述": "miniprogram has no online release",
    "解决方案": "小程序没有线上版本，即小程序尚未发布，不可进行该操作"
  },
  {
    "错误码": "85402",
    "错误描述": "invalid env_version",
    "解决方案": "参数env_version填写错误，更正后重试"
  },
  {
    "错误码": "9800003",
    "错误描述": "model_id检查不通过",
    "解决方案": ""
  },
  {
    "错误码": "9800007",
    "错误描述": "此model_id尚未获得该能力，请能力申请通过后再试",
    "解决方案": ""
  },
  {
    "错误码": "9800008",
    "错误描述": "能力类型为一机一码，sn不能为空",
    "解决方案": ""
  },
  {
    "错误码": "9800009",
    "错误描述": "能力类型为一型一码，sn需为空",
    "解决方案": ""
  }
]
```

## 7. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。