OAuth2.0能力发布操作指南更新时间:2026-04-21 22:43:01
本文档介绍了OAuth2.0能力创建的完整流程,您可按照文档内容指引进行OAuth2.0能力的创建与发布。
一、创建Oauth
首次使用OAuth2.0能力,请您先签署相关协议
.png)
勾选“我已完成阅读并同意上述协议内容”,点击确认签署完成协议签署
.png)
1、操作步骤
创建OAuth前,您需要准备OAuth的基本信息和部署信息,以下是具体步骤:
①登录并前往小米澎湃OS开发者平台-管理中心,点击“新增OAuth”按钮,即可开始OAuth首次创建。
.png)
②填写授权端点信息、首次授权(token)、失效刷新(refresh)
.png)
③点击“粘贴”,复制“首次授权”的字段信息到“失效刷新”各字段里
.png)
2、填写规范
| 字段名称 | 字段释义 | 填写规范 |
| OAuth名称 | 为 OAuth 配置起一个名称 | - 长度:1–30 字符 - 格式:名称只能包含英文、数字、下划线或横线 - 唯一性:同一开发者下名称不可重复 |
| 授权页 URL | 授权服务器的授权端点 URL,用于将用户重定向至登录授权页面 | 格式符合URL规范 |
| 授权请求参数 | 配置需要向授权服务器传递额外的固定请求参数。Miclaw回调地址为:https://api.miclaw.xiaomi.net/osbot/anonymous/authorizedapps/v1/callback | - 参数长度不超过4000字符 - 合法的 JSON 对象 |
| 回调参数解析规则 | 定义从回调 URL 中提取授权码(code)和状态值(state)的规则 | - code和state不为空 - 合法的 JSON 对象 |
| code 换取 token 的 URL | 授权服务器的令牌端点 URL,用于用授权码(code)换取访问令牌(access_token) | 令牌端点 URL必须以 http:// 或者https://开头 |
| 请求方式 | 令牌端点支持的 HTTP 请求方法 | 单选,选项为POST、GET |
| 固定请求参数 | 若授权服务器在令牌交换时需要额外参数,请以 JSON 对象格式填写 | - 格式:合法的 JSON 对象 - 长度:不超过 4000 字符 |
| 请求额外 Header | 令牌交换时需要附加的 HTTP 请求头,并自动合并到请求头中 | - 格式:合法的 JSON 对象,key为 Header 名称,值为 Header 值 - 长度:不超过 500 字符 |
| 响应解析规则 | Token 响应解析规则 | 每个值必须是合法的 JsonPath 表达式(以$开头) |
| 过期时间类型 | 指定从响应中解析出的值是相对值(从当前时间开始的有效期)还是绝对值(时间戳) | 单选,选项为相对值、绝对值 |
| token过期时间单位 | token过期的时间单位 | 单选,选项为SECONDS、MILLISECONDS |
| 刷新请求URL | 授权服务器用于刷新访问令牌的端点 URL | 令牌端点 URL必须以 http:// 或者https://开头 |
| 刷新请求方式 | 刷新端点支持的 HTTP 请求方法 | 单选,选项为POST、GET |
| 刷新固定请求参数 | 授权服务器在刷新令牌时需要额外参数 | - 格式:合法的 JSON 对象 - 长度:不超过 4000 字符 |
| 刷新请求额外 Header | 刷新请求时需要附加的 HTTP 请求头 | - 格式:合法的 JSON 对象,key为 Header 名称,值为 Header 值 - 长度:不超过 500 字符 |
| 刷新响应解析规则 | 根据实际响应结构,使用 JsonPath 指定新令牌的位置 | 每个值必须是合法的 JsonPath 表达式(以$开头) |
| 刷新过期时间类型 | 指定从刷新响应中解析出的值是相对值(从当前时间开始的有效期)还是绝对值(时间戳) | 单选,选项为相对值、绝对值 |
| 刷新token有效期单位 | token过期的时间单位 | 单选,选项为SECONDS、MILLISECONDS |
| 刷新过期时间值 | 根据授权服务器的实际要求,配合刷新token有效期单位 | refresh_token固定过期时长,配合unit使用,0=不过期 |
二、提交审核
当所有信息都填写完成后,您可点击“提交审核”按钮,此版本OAuth即会进入审核流程。提交审核后返回列表页,可在列表状态字段中查看审核状态
.png)
.png)
我们将会在1~3个工作日内完成审核,推荐您关注应用商店开发者服务公众号,如有兴趣可了解OAuth 2.0能力,成为我们的合作伙伴。 以上为小米澎湃OS开发者平台OAuth2.0能力发布操作指南,如有任何问题,可联系客服,与我们取得联系。
上一篇:MCP服务发布操作指南
下一篇:Skill技能发布操作指南
文档内容是否有帮助?
有帮助
无帮助