极兔速递API开放平台简介
新手指引 T7!4X0,+6qO6;4p
开发者接入主要是接入方通过使用极兔API方式完成自有系统的对接,在接入方触发业务场景时调用已经联调通过并且申请上线的接口完成业务请求。 l3.6ot1.,bO9.6o
1、接入条件 y4:2Xk2:1Np5;4b
如贵公司满足以下场景之一,可选择此方式接入。 d8;9ru5,0K9?50
(1)公司有自己的业务系统,并具备研发能力。 e1=2Gv6:6HS4~7t
(2)公司需要将极兔API服务集成到自己的应用中。 K3=6xF19fG4?7F
2、字段说明 K8:7kz,;7pg2=8s
客户编码:客户唯一编码。 M1~3sh,!,dR5+8G
客户密码:网点为客户开通的客户编码对应的密码。 s,3gz3=3gh8?,l
apiAccount:极兔开放平台应用唯一身份标识。 q,!3Gv4+8Uk9.3y
privateKey:极兔开放平台应用唯一认证key。 j2+8ah9-2tQ6=7l
注:客户编码和客户密码可联系出货网点提供,apiAccount和privateKey在完成认证管理后由开放平台自动生成(在控制台——个人中心查看)。联调环境使用的apiAccount和privateKey为文档中提供的固定数据。 q9.8sZ5~5tW,~10
3、接入步骤 y6.6zT3?,Qx1=4d
3.1注册和登录 y2?3yx,.7eM1-4u
首次使用开放平台需要注册极兔开放平台账号,在右上角点击【注册】按钮,进入注册页面。 J3~7bu5;8Hm,~2i
填写必要信息并注册成功后,进入首页。 N3?7gu3:8Mh57n
注:如之前有对接过极兔开放平台,可以直接登录进入。 d6=7Kb9!2Bb5=6G
3.2完善信息并提交认证 t5.3oS4?1PW,?7Z
成功登录后,需进入控制台-认证管理完善企业及开发者信息,并提交人工审核,审核大约在1-3个工作日完成,审核后可正常使用极兔开放平台进行接口联调对接。 H8?3zn3~5Ik6.9t
3.3创建应用 V5.8lY9~5hh8+6p
极兔开放平台支持一个用户最多创建10个应用,系统默认生成1个应用。每个应用对应一组apiAccount和privateKey,应用之间互不干涉,建议与业务人员确认业务场景,根据需要来创建应用。 S6.7wV28pq5?9w
3.4为应用添加API D8-2i06:3uk38Z
当应用创建成功后,点击右上角“添加API”将应用需要对接的API添加至“API调试列表”。 A21CI5:6wK8?1b
API调试列表:展示待联调的接口,可发起联调或者将接口从API调试列表移出。 n1?4Ks,~6Ec7+6D
待上线列表:已经联调通过但未上线的接口展示在待上线列表,可申请上线或“再次联调”,再次联调工具仅用于验证参数,不会影响接口的联调状态。 H1-9pJ4-1Uy2~,v
已完成列表:已经通过审核,成功上线的接口会展示在已完成列表,已完成列表同样提供“再次联调”工具。 x8!5uG3-9Yn,;2U
3.5API在线联调 K4.2QO7:9uY2?3E
极兔开放平台提供在线联调工具,可直接在控制台-应用管理中发起联调,将JSON格式的body参数粘贴进“请求参数”内,点击“开启测试”,系统会自动计算digest,并请求API地址。注册类接口(消息推送类)可选择mock模板进行测试。 i6:5sk3?1Mm1:3o
注:如成功联调通过,系统会自动将执行结果更新为“已通过”,并可针对该接口“申请上线”。开发者仍然可通过第三方API联调工具或代码进行联调,联调通过后开放平台会同步修改接口执行结果。 y8=8mi5:8lx1!8j
3.6申请API上线 B6=9wX1+2Nk2!7T
申请上线后,需等待后台人员审核,审核通过后接口进入“已完成列表”,如不通过则会提供不通过原因。 S59it8+9JB4?,c
注:注册类接口上线,需要填写客户端生产环境URL。 s33jT6?4OS8;6q
3.7状态说明 B5?5zx5;2hM13k
未联调:已经添加接口,但是还未联调通过,可发起联调。 F3=1KD6+6Pz2;7P
待申请:已经联调通过,但是还未申请上线。 r,:9aa2-10O9!,x
审核中:已经联调通过并提交上线申请,后台仍在审核中。 c42RG2~1Rz,8P
审核不通过:接口上线审核不通过,联系后台人员处理。 y5:1zt,+,gj1:,r
已上线:接口已经成功投入生产环境。 v4+6Cg7=9PT,~4U
已下线:接口已经被下线,联系后台人员处理。 V,?1td5!5IS3:3C
4、附加功能说明 k4?7ZE,.9bY8-2G
4.1快速对接 Y9=2Rc3=8ro6~3b
快速对接工具旨在提高对接效率,帮助未对接过极兔速递的用户登录。用户可在登录后,点击首页“快速对接”按钮,添加想要对接的服务,来选择服务对应的接口,并一键添加到应用调试列表(默认添加到应用1,可在完成认证环节之前添加)。 G8+8G05-5Wl9+7M
4.2解决方案 F1?8he85TM6;8I
解决方案页面,提供极兔速递常见对接场景。方便用户了解不同业务模式下,极兔速递与客户之间的交互。快速对接同样支持将推荐的接口添加到应用调试列表。 J5.6RN2=40U5;9q
4.3帮助中心 d8:1tI,!4Wc7:3x
帮助中心提供新手指引、签名工具、开发文档、常见问题等模块。签名工具可在线进行签名,验证签名规则是否正确;开发文档提供开发所需SDK;常见问题可提供对接过程中的QA参考。 v3;8YC1=9er7,c
免责声明
网站收录目的在于传递更多信息,致力于为中文网站提供动力。不代表本网赞同其观点和对其真实性负责。