重要说明:

  • 北向接口通常用于与第三方对接时实现回调的接口,即:业务 > 南向接口 > 第三方(含北向的回调) > 处理 > 第三方 > 北向接口 > 业务接口
  • 由于该接口是直接公开暴露的,即间接把业务接口对外公开了,因此需要在业务中做一些安全防护
    • 需要用户身份信息场景:在适配器中获取相关的账号参数进行模拟登录,再执行业务接口调用
    • 不需要用户身份信息场景:
      • 在业务正向接口中生成回调的北向接口地址时做好签名,包括时间限制等机制,用于回调时检查验证
      • 业务接口使用 @Inner 注解,调用时遵循内部调用规则(不经过网关调用,header带from=Y)
  • 切记不要把业务接口直接列表白名单对外暴露,避免带来更多的风险

整体流程

创建套件 - 配置协议 - 上架协议 - 创建第三方系统适配器 - 创建第三方系统参数要求 - 适配协议 - 编写脚本 - 上架适配器
业务集成 - 上架应用 - 安装应用 - 配置协议及适配器 - 使用

定义阶段

与”南向(应用->第三方)“ 示例一致

添加API协议

我的套件 > 查看协议 > 创建API协议

  • API套件上架

适配阶段

API模型适配

  • 创建适配器

我的套件 > 查看适配器 > 创建适配器

适配代码

集成阶段

API模型集成

  • 申请授权并添加API套件

我的套件 > API权限 > 申请开通 > 添加API套件 > xxx套件

业务集成

后端接口

业务应用提供一个接收 “北向(第三方->应用)” 协议适配器统一调用的接口

安装阶段

业务上架安装

与”南向(应用->第三方)“ 示例一致

配置适配器及参数

  • 配置黑白名单

  • 适配器参数

  • 北向协议访问URL

使用阶段

业务使用演示

第三方平台直接调用北向地址提供的协议URL

文档更新时间: 2023-07-30 12:18   作者:管理员