开通API 对接教程
优权益系统 API 对接教程
本文将详细介绍如何通过优权益系统的 API 对接功能,实现商家与用户系统之间的无缝连接。通过创建 APPID 和密钥,商家可以通过 API 完成下单、查询商品等操作,提升系统对接效率。
1. 创建 APPID 和密钥
商家可以在优权益开放平台中为客户创建 APPID 和密钥,用于 API 的对接操作。以下是创建过程的主要步骤:
1.1 创建 APPID
- 登录运营中心。
- 进入【开放平台】【站外 APPID】【创建 APPID】
- 填写必要信息,包括系统编号(默认)或自定义编号。自定义编号可以通过商家在商品规格页面设置,以便在对接时使用。
1.2 配置对接模式
- 系统编号(默认):使用本系统生成的产品规格 ID进行对接。
- 自定义编号:商家可以将原有系统的产品编号作为自定义编号,确保客户不需要重新绑定商品即可完成对接。
1.3 设置 API 接口权限
商家可以选择对接 API 的权限,确保 APPID 只能够访问特定的外部 API。
1.4 绑定账号与通知地址
- 订单通知地址:当订单完成或退款时,系统会通过此地址通知下游。未配置订单回调调通地址时 ,下游订单将无法实现自动发货 和自动退款 ,请务必正确配置。
- 商品通知地址:当商品价格或状态发生变化时,系统会通知下游。
1.5 IP 白名单
开启 IP 白名单后,只有通过白名单 IP 的请求才能成功访问 API,防止恶意查询。
1.6 调试模式
如果在开发过程中遇到签名验证问题,可以开启调试模式。开启后,将返回加密前的正确字符串,帮助开发者排查问题。
2. 产品授权
创建 APPID 后,商家需要进行产品授权,以便该 APPID 有权限可以访问和操作产品。
2.1 授权产品
商家可以一键授权所有产品或单独授权特定产品。授权后,可以设置独立的对接利润,确保在对接过程中按照特定的价格进行结算。
- 独立对接利润:除原有价格规则外,可以为特定产品设置仅在对接时生效的利润。例如,产品价格 = 成本价 + 独立利润。
2.2 取消授权
如果不再需要某个 APPID 访问特定产品,可以一键取消所有授权或单独取消授权。
2.3 是否允许对接
商家可以设置产品规格是否允许对接。如果关闭对接,则该产品无法通过 API 查询或购买。
3. 订单回调与商品通知
商家和客户都可以设置订单回调地址和商品通知地址。
- 订单回调地址:用于接收订单完成或退款通知。
- 商品通知地址:用于接收商品价格和状态变化的通知。商家可以通过对接接口订阅产品通知,只有订阅的产品才会发送通知。
4. 客户端使用
客户可以在会员中心查看自己的 APPID 信息、授权的产品,以及设置订单回调和商品通知地址。
4.1 查看对接信息
客户可以在开放平台 API 对接页面查看自己已经创建的 APPID 和授权产品。
4.2 设置通知地址
在会员中心,客户可以设置订单通知和商品通知地址,确保能够及时接收到相关通知。
5. 禁用 APPID
商家可以选择禁用某个 APPID,禁用后,该 APPID 将无法继续访问 API。禁用操作快捷,确保商家能够迅速切换或暂停对接。
6. 结语
通过优权益系统的 API 对接,商家和用户可以实现便捷的产品查询、下单和通知操作。只需按照上述步骤配置并授权产品,您就能够实现与不同系统和商家的对接,提升系统的效率和灵活性。
如果您在对接过程中遇到问题,请参考本教程,或与我们的技术支持团队联系。
7. 常见问题
1. 提示无权限
请按照以下步骤检查权限问题:
- 检查是否给客户开启 API 对接权限
-
检查请求的接口是否有权限
-
检查对应的产品是否已授权