开发者在接入API时,常会遇到一些问题:没有“添加能力”,导致无权限调用,一直调用一直失败;接入时没有“签约产品”,导致接口多次报错,开发者无解。
究其原因,多是由于开发者对API接入流程不熟悉所致。因此,支付宝开放平台提供了“AIT”(API集成工具集)的产品。
这一次,我们邀请负责API集成的产品经理琛羽,由他来为大家讲解,如何登上“AIT”这趟高速列车,并开启更高效、体验更优的“API接入”之旅。
能力集成的两条“线路”
琛羽:首先,很多开发者疑惑:“AIT”到底是什么,一言以蔽之:AIT(Api Inside Tools)是针对API集成,实现工具与集成流程相融合的一整套实用工具套件。
这个产品的价值是:让开发者在集成过程中的各个主要卡点,如开发配置、接口时序调用、单个API的调试、错误排查等方面,都有产品工具可使用,更高效地了解能力、接入能力。
通常,开发者在集成能力时会有两条线路:第一条是依靠“集成助手”这个工具,step by step进行操作,在工具指引下完成接入。
第二条则是开发者查阅“集成文档”,自助式完成接入。
接下来,我会以“集成文档”这条线路,通过“商家券”的能力文档展开说说,都有哪些工具可用,大家也可以打开文档,跟着我一起尝试。
集成之旅“第一站”:了解能力
接入前,开发者首先想了解到底哪个能力是我所需要,毕竟相同功能的能力,在不同平台可能叫法不一,加上支付宝开放平台一些特有的名词,容易让开发者混淆。
因此我们提供一套统一术语库(AKU),可以理解为API接入的“在线新华字典”。开发者在阅读集成文档时,遇到陌生名词,鼠标悬停一下,就能看到注释卡片,用精练的语言做名词解释,还可以点击了解更多相关问题。
集成之旅“第二站”:接入准备
不少能力有使用门槛,所以接入前有一系列配置以验证是否符合要求。
这里涉及到账号、应用、能力三层关系,有点像写作文里的谁(who)——账号,在哪里(where)——哪个小程序,做什么(what)——用什么能力。
往往开发者会在配置过程中遗漏配置项,导致报错。
为此,我们推出“配置项检测工具”:当选择账号及开发类型后,工具会自动检测出未完成的配置项,并给到对应操作指引,开发者只要按指引一一完成配置项后,就能前置避免报错。
集成之旅“第三站”:能力Demo
进入开发阶段,许多开发者问:有没有官方提供,可参考的Demo示例,想真实体验一下能力的使用过程?对此,我们提供“在线Demo调试工具”,这个工具的优点在于:
① 自动对接支付宝隔离的“沙箱环境”,不会对线上造成影响。
② 每一步都有明确指引,开发者不需要做任何输入,只要按步骤点选就能完成环境搭建。
③ 开箱即用,前后端一体的Demo示例可直接运行、断点调试。开发者还可以下载复制Demo到自己的工程里,完成能力最小限度开发。
集成之旅“第四站”:API调试
如果开发者想聚焦到单个API,了解API某些参数含义,以及接口实际调用请求和返回的内容时,API Explorer这一工具就派上了用场。
通过API Explorer,开发者可以在沙箱环境下进行单API的调试和体验,同样,在工具中动态生成的代码示例,开发者也可以复制到自己的工程里进行学习,完成相应的接口开发工作。
集成之旅“第五站”:诊断排查
在能力接入过程中,开发者最怕的就是报错,过去的解决路径是:提供错误码、APPID、时间给官方小二捞日志→定位问题→小二给到解决方案→重新调整,整个“求医过程”漫长而痛苦。
而通用解决方案又往往无法跟具体Case关联,“远水接不了近渴”。
因此,我们推出了“接口报错排查工具”,开发者填写错误码及接口后,工具会自动进行日志分析,给到报错真正原因及参考建议。未来还会支持与IDE报错相结合,当IDE里报错后,会在报错信息里拼接诊断工具地址,自动导入信息,查看诊断结果。
集成之旅“终点站”:集成验收
当接口调通,没有返回报错之后,是否真的意味着能力接入成功?其实开发者还缺少一个在业务层面,明确能力成功接入的标志。
为此,我们将提供“云验收”工具:当开发者输入相关因子之后,就能看到很明确的业务验收结果,实现能力集成的“最后一公里”。
以上是“AIT”主要的接入提效工具,欢迎开发者在社区“建议”版块向我们反馈能力接入卡点问题,一起让“AIT”这趟列车继续提速,让能力接入“快人一步”。
PS:你还想深入了解哪一项小程序开发产品?我们会邀请对应产品经理与大家对话,大家可以在下方回帖告诉我们~~