支付宝开放平台文档中心致力于为客户提供更好的阅读体验。基于内外部用户多次反馈文档更新无法及时感知和通知到相关方的问题,文档中心上线了文档更新动态订阅能力,以将各开放产品和平台产品的升级变化及时通知到客户。
可订阅的文档范围:
- 当前已支持:o站全面开放的所有产品文档、b站《产品能力升级日志》。
- 未来订阅功能将逐步覆盖不同的文档。
文档更新订阅相关操作说明如下:
1.查看文档更新记录
单篇文档新增「文档更新记录」功能,点击即可查看文档所有更新记录。若文档最近一个月有更新,文档标题旁会有「更新」标记。
2.订阅文档
在单篇文档的工具栏,新增「订阅更新」功能。开发者可根据个人需求,自主选择订阅单篇文档或整套产品文档。
已经订阅的文档列表可在「我的文档」中查看
3.接收文档更新信息
订阅后的文档可通过两个渠道同时接收消息:站内信、钉钉消息,未来将新增邮件渠道。接收的消息内容包含文档链接和文档更新详情链接。
钉钉消息接收:用户点击【订阅更新】,钉钉中将收到组织邀约信息,点击同意加入支付宝开发者钉组织,即可成功开启接收钉钉消息通知。
第一步:点击【订阅更新】按钮
第二步:在钉钉中点击【同意】加入钉组织
第三步:通过钉钉消息接收文档更新
注意:
1. 登录开放平台的手机号要与钉钉手机号保持一致,否则将无法接收到消息。
2. 如没有安装钉钉,需要安装登录后(手机号与登录开放平台保持一致),才可接收消息。
站内信接收:用户点击【订阅更新】,无需额外操作,即可成功开启站内信触达
第一步:点击【订阅更新】按钮
第二步:通过站内信接收文档更新
消息推送规则:
- 每天上午10点固定时间推送,一天仅推送一次(若有更新)
- 一次推送中包含订阅的有更新的全部文档
附:文档订阅和API中心能力订阅的关系
- 文档订阅和能力订阅二者并无耦合关系,用户可以都订阅,也可以只订阅其中一个。
- 能力动态 包含 能力文档更新日志(同步文档变更) + 相关工具更新(维持现有人工变更)。
- 消息接收逻辑:
1)只在API中心订阅能力:收到API能力动态通知(接入文档更新日志后,能力动态触达会更及时&丰富)
2)只订阅能力文档:收到文档订阅通知
3)又订阅了能力、又订阅了能力文档:会收到两条通知:你关注的API能力有更新 & 你关注的文档有更新
用户之声
未来计划订阅文档后新增邮件作为触达渠道,目前有两种方案:
方案一,开发者订阅成功后平台自动获取个人支付宝帐号绑定的邮箱,后续文档更新信息直接发送到该邮箱;
方案二,开发者点击订阅后主动填写个人常用的邮箱帐号,后续文档更新信息发送到开发者填写的个人邮箱中。
我们期待听到开发者对于邮件渠道及订阅填写邮箱的声音,欢迎在评论区发表建议。