全球商业网络
  1. 3.文档管理
全球商业网络
  • 接口文档
    • 1.认证授权
      • Oauth2认证
    • 2.企业管理
      • 企业注册接口
    • 3.文档管理
      • 1.发送UBL文档接口
        POST
      • 2.接收到文档通知接口
        POST
      • 3.根据文档id获取UBL文档内容
        GET
  • 业务文档
    • 1.企业信息
      • 1.企业信息字典信息
    • 2.UBL文档
      • 1.UBL文档说明
      • 2.文档profileId说明
      • 3.文档数据枚举定义
      • UBL示例说明
        • RemittanceAdvice
        • RequestForQuotation
        • Quotation
        • Enquiry
        • EnquiryResponse
  • 产品目标
    • 1.商业网络818发布
      • 1.商业网络818目标
  • 产品对接
    • 1.采购Baas
      • 1.对接说明
      • 2.数据样例
    • 2.银企联
      • 1.对接说明
      • 2.数据样例
  1. 3.文档管理

2.接收到文档通知接口

测试中
开发环境
10.255.5.51
开发环境
10.255.5.51
POST
10.255.5.51
/document/received/callback
这个接口需要业务方提供,当AP收到UBL文档时,会调用业务方该接口通知收到文档数据(该方式不考虑身份)。具体接口UBL(业务方自行定义,可以参考该接口的定义)。
关于接口安全性处理:
推送给业务接口的数据是对称加密加密后的字符串,通过clientId对应的 clientSecret进行采用约定好的对称加密算法进行加密, 解密后的报文如下:
{
  "documentId":"01H6MYGGHHDN12JAXP1HXXG9XF", //文档id
  “documentProfileId”:"yonyou.quotation.cn.1.0", //文档定义id
  "traceId":"1685528522034065408" //请求跟踪id
  "eventType":"after-document-received"
}
推送的地址为配置文档定义时指定的appkey 和 回调地址。
eventType:
after-document-received 收到文档事件
conversation-state-added 文档状态变更
为了简化加密算法暂时固定为 SM4/ECB/PKCS5Padding(后续根据再继续扩展) , 工具可以使用hutool,https://doc.hutool.cn/pages/SmUtil/#%E4%BB%8B%E7%BB%8D
加密流程,根据加密算法特性key长度,随机截取clientSecret固定长度字符串作为对称加密的key,进行解密

请求参数

Body 参数application/json
data
string 
加密字符串密文
必需
alg
string 
加密算法
必需
目前只支持国密对称加密算法 SM4,后续再扩展
s1
integer 
密钥的开始位置
必需
clientSecret
s2
integer 
密钥的结束位置
必需
clientSecret
clientId
string 
客户点id
必需
示例
{
    "data": "string",
    "alg": "string",
    "s1": 0,
    "s2": 0,
    "clientId": "string"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '10.255.5.51/document/received/callback' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": "string",
    "alg": "string",
    "s1": 0,
    "s2": 0,
    "clientId": "string"
}'

返回响应

🟢200成功
application/json
Body
code
string 
处理结果编码
可选
msg
string 
处理结果提示
可选
success
boolean 
是否处理成功
必需
示例
{
    "code": "string",
    "msg": "string",
    "success": true
}
上一页
1.发送UBL文档接口
下一页
3.根据文档id获取UBL文档内容
Built with