统一开放平台（正式）
  1. 准备开发
统一开放平台（正式）
  • 准备开发
    • 接口调用说明
    • SDK包下载
    • 公共响应码
  • 基础数据API
    • 查询联行号信息
      POST
  • 银行账户API
    • 根据支付单据查询对应明细回单接口
      POST
    • 查询银行电子回单单个
      POST
  • 收付结算API
    • 创建应付单信息
      POST
    • 查询付款结果
      POST
  1. 准备开发

接口调用说明

公共API说明#

财资云系统公共API请求通过SDK包方式访问，租户需先下载对应SDK包（java语言），将SDK包引入到项目中，通过调用对应的方法请求公共API接口。
请求公共之前，需配置对应接口的网关权限，只有开放对应权限的才能访问财资系统的公共API。

网关权限配置#

网关权限配置介绍#

租户登录财资云系统，可以在菜单：数据中心->BIS接口配置->网关权限配置 页面中配置网关请求的相关参数。
配置内容：接口加签方式(RSA2或SM2)、对应加签方式公钥、IP地址白名单、CFS网关地址获取、接口内容加密方式设置（AES或SM4）、自动生成加密密钥、管理应用可访问的能力权限等。 网关权限的管理和配置，将作为后续使用SDK访问公共接口的基础数据。

网关权限配置-应用服务新增#

点击“新增应用服务”，可新增一笔应用信息。对应用内容进行填写，并保存。
image.png
image.png
网关应用服务配置成功后，可以在应用列表中看到新增的应用,点击列表中新增的应用,可以看到右侧应用信息中显示新增的应用信息,APPID由系统自动生成;

网关权限配置-开发信息配置#

财资云网关地址#

测试环境网关地址: https://openapi-pre.yocyl.com/api
生产环境网关地址:https://openapi.yocyl.com/api

接口加签方式设置#

接口加签方式目前平台提供RSA2和SM2两种加签方式,租户可以自行选择并配置对应加签方式的公钥信息(常用RSA2,租户生成秘钥对,将公钥信息填入对话框),并保存。
image.png
image.png
配置好加签方式以及加签方式对应的公钥并保存后,状态变为已设置,租户点击 设置/查看按钮,可查看上一步设置的公钥(应用公钥)以及财资平台对应加签方式的公钥(CFS公钥)。
image.png
image.png
加签变更,可以对已经设置的加签方式和对应加签公钥进行修改。
image.png
image.png
image.png

接口内容加密方式设置#

接口内容加密方式目前平台提供AES和SM4两种加密方式,租户可以自行选择并点击“生成密钥”按钮生成已选择加密方式对应的密钥(常用AES),完成设置。
image.png
image.png
image.png
租户可对已经生成的接口内容加密密钥进行查看,点击当前已设置接口内容加密方式 设置/查看按钮,即可查看已经设置好的接口内容加密方式以及生成的对应加密方式密钥;
image.png
image.png
租户可对已经生成的接口内容加密方式对应的密钥重新生成(加密方式不可重新选择),点击当前已设置接口内容加密方式 设置/查看按钮 ,在弹出的对话框点击 重新生成密钥 按钮即可重新生成已经设置好的加密方式对应的密钥;
image.png

服务器IP白名单设置(非必要设置项)#

服务器IP白名单,可以配置通过SDK访问财资云公共接口的IP地址,在平台配置过的IP可以访问,反之没有在IP白名单中配置过的IP将不能访问,如需设置IP白名单,进行添加并点击完成后设置生效。(不设置则不对访问IP进行限制)
image.png
image.png
image.png
如有多条可以点击新增按钮添加多条;
image.png

网关权限配置-网关能力配置#

“能力列表”是后续使用SDK访问公共接时必须设置的内容,需要对开发信息进行补全配置，添加能力 的方式获取各种能力（如收付结算、基础数据、对账凭证等）接口调用权限并进行开发。
应用类型包含：银行账户API ,对账凭证API,基础数据API,收付结算API,投融资API
如需访问对应能力下的接口 必须在当前应用下添加需要访问对应接口的能力，否则将无权限访问对应接口；

新增能力#

在应用信息能力列表栏目，点击新增按钮，右侧弹出能力选择抽屉对话框，选择需要添加的能力，点击添加按钮，完成添加操作。
image.png
image.png
image.png

删除能力#

对于已经添加的应用能力，租户可以进行删除操作，在能力列表中 选择需要删除的能力，点击删除按钮，在弹出的对话框中，选择确定删除对该应用当前选择的能力进行删除操作，选择取消，则回到当前应用页面。
image.png
image.png
image.png

公共API调用#

租户通过网关权限配置功能,配置好开发信息,已经该应用能力列表后,可通过财资云提供的公共SDK包,访问财资云公共API

SDK引用#

将公共SDK包依赖引入项目
<dependency>
    <groupId>com.yocyl</groupId>
    <artifactId>hci-bis-sdk</artifactId>
    <version>x.x.x</version>
</dependency>

使用SDK#

请求头示例:
具体接口请求代码见API接口示例。
修改于 2023-06-30 08:30:48
下一页
SDK包下载
Built with