生成SchemaV2
收藏接口说明
该接口用于生成能够直接在端内跳转小程序的 schema。
根据参数生成 schema 链接，在端内跳转到指定小程序页面。
- 长期有效 schema，可通过no_expire指定，生成后可永久使用。
- 短期有效 schema，需传入到期时间的 Unix 时间戳，最长距离当前时间 180 天。
使用限制
该接口设有频次限制，如有特殊需求请 oncall。
- 短期有效：每日上限不超过50万条，qps最高100
- 长期有效：配置上限不超过10万条，qps最高100。
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | |
| HTTP Method | POST |
| Scope | ma.share.schema |
| 权限要求 | 开发者类型：企业开发者 生成能够直接跳转到端内小程序的schema 满足任一能力即可 查询已经生成的小程序的schema 满足任一能力即可 查询小程序可生成的schema配额 满足任一能力即可 Schema链接 满足任一能力即可 开发者类型：个人开发者 生成能够直接跳转到端内小程序的schema 满足任一能力即可 查询已经生成的小程序的schema 满足任一能力即可 查询小程序可生成的schema配额 满足任一能力即可 Schema链接 满足任一能力即可 |
请求参数
请求头
access-token必填String
示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Body
app_idString
示例：tt**************
小程序ID
expire_timeInt64
示例：1685090014
到期失效的 schema 的失效时间，为 Unix 时间戳，短期有效schema必传，最长间隔天数为180天。
no_expireBool
示例：true
生成的 scheme 码类型，短期有效:false，长期有效:true。默认值false。
pathString
示例：pages/index
通过 schema 进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query。path 为空时会跳转小程序主页。
queryString
示例：{\"key1\":\"val1\",\"key2\":\"val2\"}
通过 schema 进入小程序时的 query（json形式）。最大1024个字符，只支持数字，大小写英文以及部分特殊字符：`{}!#$&'()*+,/:;=?@-._~%``。
version_typeString
请求示例
curl --location 'https://open.douyin.com/api/apps/v1/url/generate_schema/' \ --header 'access-token: clt.01********3d3d' \ --header 'Content-Type: application/json' \ --data '{ "app_id":"tt5da*****", "query":"{\"key1\":\"val1\",\"key2\":\"val2\"}", "path":"test_miniapp", "no_expire":false, "expire_time":1685090014 }'
响应参数
Body展开全部子属性
dataStruct
展开子属性
err_msgString
err_noInt32
log_idString
响应示例
正常响应示例异常响应示例
{ "data": { "schema": "sslocal://miniapp?ticket=v1_*****" }, "err_msg": "", "err_no": 0, "log_id": "20230828105040791DAA4F7CABB43F2E0D" }
切换单列布局错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 0 | 成功 | |
| 200 | 28005015 | 权限被封禁 | 权限被封禁 |
| 200 | 28005002 | 内部错误 | 重试 |
| 200 | 28005078 | 到期时间不在范围内 | 到期时间不在范围内 |
| 200 | 28005075 | 生成Schema频率过快 | 生成Schema频率过快 |
| 200 | 28005076 | 生成Schema数量超过上限 | 生成Schema数量超过上限 |
| 200 | 28001003 | access_token无效 | 重新获取access_token |
