流程管理系统API文档
- 流程：在这个语境中指的是一系列事先决定的事件的集合。事件有可能有先后顺序，也有可能无序发生或者同时发生。需要按照顺序完成的叫有序性流程，不需要按照顺序完成的叫做完备性流程。
- 事件：事件指的是在流程范围内需要完成的操作。
- 数字证据：包含操作痕迹、数字文档、数字协议，以及上述操作或数据的数字签名
- 所有API的
Method均为POST - 所有API的
Content-Type均为application/json;charset=UTF-8 - 所有API的
返回类型均为application/json;charset=UTF-8
- URL:
/api/procedure-type-list
- 参数：
| 参数名 | 解释 | 例 |
|---|---|---|
| token | 机构的API账户标志 | 417fXkWTP85uE8LXZH9nqCZn3r3JjsTl |
| datetime | 调用时间（UTC时间） | 2020-01-22T09:12:43Z |
| signature | 机构的数字签名的Base64编码 | MIGIAkIB8HKnnrj5tMwEPVC... |
- 签名字段：
- token
- datetime
- 返回字段：
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| proTypeId | int | 流程类型的ID |
| proTypeName | string | 流程类型的名称。例如供应链金融中的“应收账款抵押”，“票据质押贷款”等 |
| proSteps | int | 流程总步骤数 |
| eventTypeIdArray | int数组 | 该流程包含的事件类型ID的数组 |
| comments | string | 备注或解释 |
- 返回样例：
{"msg":[{"proSteps":5,"eventTypeArray":[{"comments":"企业提交融资申请","eventTypeId":1,"eventTypeName":"融资申请","preEventTypeId":null,"proTypeId":1},{"comments":"企业复核融资申请","eventTypeId":2,"eventTypeName":"企业复核","preEventTypeId":1,"proTypeId":1},{"comments":"平台融资初审","eventTypeId":3,"eventTypeName":"平台融资初审","preEventTypeId":2,"proTypeId":1},{"comments":"平台融资终审","eventTypeId":4,"eventTypeName":"平台融资终审","preEventTypeId":3,"proTypeId":1},{"comments":"流程结束","eventTypeId":5,"eventTypeName":"流程结束","preEventTypeId":4,"proTypeId":1}],"comments":"票据质押基本流程","proTypeName":"票据质押","proTypeId":1}],"code":0}- URL:
/api/procedure-list
- 参数：
| 参数名 | 解释 | 例 |
|---|---|---|
| proId | 可选参数；用于找到该proId的流程实例 | 123 |
| proTypeId | 可选参数；用于找到所有属于proTypeId的流程实例 | 123 |
| from | 可选参数；用于找到从这个时间开始创建的流程实例 | 2020-01-22T09:12:43Z |
| to | 可选参数；用于找到到这个时间结束的流程实例 | 2020-01-22T09:12:43Z |
| token | 机构的API账户标志 | 417fXkWTP85uE8LXZH9nqCZn3r3JjsTl |
| datetime | 调用时间（UTC时间） | 2020-01-22T09:12:43Z |
| signature | 机构的数字签名的Base64编码 | MIGIAkIB8HKnnrj5tMwEPVC... |
- 签名字段：
- proId
- proTypeId
- from
- to
- token
- datetime
- 返回字段：
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| proId | long | 流程实例的ID |
| proTypeId | int | 流程类型的ID |
| businessCode | string | 平台业务代码 |
| proName | string | 流程实例的名称。命名规则：融资方代号_流程编号_日期 |
| proStatus | byte | 流程当前状态-即实现的步骤数。例如：0=尚未启动 1=合同上传并完成数字签名 等。 |
| comments | string | 备注 |
- 返回样例：
{"msg":[{"businessCode":"B00000001","comments":"测试","proDatetime":"2021-01-15T05:48:19Z","proId":3223007475531822,"proName":"test","proStatus":0,"proTypeId":1}],"code":0}- URL:
/api/create-procedure
- 参数：
| 参数名 | 解释 | 例 |
|---|---|---|
| proTypeId | 流程类型的ID | 123 |
| businessCode | 平台业务代码 | B01254625 |
| proName | 流程实例的名称。命名规则：融资方代号_流程编号_日期 | 00001_001_20201203 |
| comments | 备注 | 某公司票据抵押融资 |
| token | 机构的API账户标志 | 417fXkWTP85uE8LXZH9nqCZn3r3JjsTl |
| datetime | 调用时间（UTC时间） | 2020-01-22T09:12:43Z |
| signature | 机构的数字签名的Base64编码 | MIGIAkIB8HKnnrj5tMwEPVC... |
- 签名字段：
- proTypeId
- businessCode
- proName
- comments
- token
- datetime
- 返回字段：
- 成功：proId
- 失败：失败原因
- 返回样例：
{"msg":3212782118895662,"code":0}- URL:
/api/event-type-list
- 参数：
| 参数名 | 解释 | 例 |
|---|---|---|
| proTypeId | 可选参数；用于找到所有属于proTypeId的事件类型 | 123 |
| token | 机构的API账户标志 | 417fXkWTP85uE8LXZH9nqCZn3r3JjsTl |
| datetime | 调用时间（UTC时间） | 2020-01-22T09:12:43Z |
| signature | 机构的数字签名的Base64编码 | MIGIAkIB8HKnnrj5tMwEPVC... |
- 签名字段：
- proTypeId（如果不填该参数，签名时将其值设为null）
- token
- datetime
- 返回字段：
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| eventTypeId | int | 事件类型的ID |
| proTypeId | int | 事件类型所属的流程类型ID |
| eventTypeName | string | 事件类型的名称 |
| preEventTypeId | int | 当前事件类型的前置事件类型，只有前置事件类型的事件实例完成后，才能进行该事件。第一个事件的前置ID为null |
| comments | string | 备注 |
- 返回样例：
{"msg":[{"comments":"企业提交融资申请","eventTypeId":1,"eventTypeName":"融资申请","preEventTypeId":null,"proTypeId":1},{"comments":"企业复核融资申请","eventTypeId":2,"eventTypeName":"企业复核","preEventTypeId":1,"proTypeId":1},{"comments":"平台融资初审","eventTypeId":3,"eventTypeName":"平台融资初审","preEventTypeId":2,"proTypeId":1},{"comments":"平台融资终审","eventTypeId":4,"eventTypeName":"平台融资终审","preEventTypeId":3,"proTypeId":1},{"comments":"流程结束","eventTypeId":5,"eventTypeName":"流程结束","preEventTypeId":4,"proTypeId":1}],"code":0}- URL:
/api/event-list
- 参数：
| 参数名 | 解释 | 例 |
|---|---|---|
| eventId | 可选参数；用于找到该eventId的数据 | 123 |
| proId | 可选参数；用于找到所有属于proId的所有事件实例 | 123 |
| eventTypeId | 可选参数；用于找到所有属于eventTypeId的事件实例 | 123 |
| token | 机构的API账户标志 | 417fXkWTP85uE8LXZH9nqCZn3r3JjsTl |
| datetime | 调用时间（UTC时间） | 2020-01-22T09:12:43Z |
| signature | 机构的数字签名的Base64编码 | MIGIAkIB8HKnnrj5tMwEPVC... |
- 签名字段：
- eventId（如果不填该参数，签名时将其值设为null）
- proId（如果不填该参数，签名时将其值设为null）
- eventTypeId（如果不填该参数，签名时将其值设为null）
- token
- datetime
- 返回字段：
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| proId | long | 事件实例所属的流程实例ID |
| eventId | long | 事件实例的编号 |
| eventTypeId | int | 事件类型的ID |
| eventName | string | 事件实例的名称。命名规则：融资方代号_事件的融资方内部编号_日期 |
| eventStatus | byte | 事件状态。0=尚未完成，1=通过初审，2=通过二审，3=一级交叉验证完成… 等 |
| eventDatetime | string | 事件时间（当前完成的最晚时间，UTC时间） |
| isComplete | boolean | 是否完成 0=未完成 1= 完成 |
| isDiscard | boolean | 是否已经被丢弃（如果有存证文档的修改，需要新建一个事件实例，旧版的实例会被标记为discard） |
| crossChecked | byte | 是否完成交叉验证（大数据交叉验证为可选）0=没有交叉验证 1=1度交叉验证 2=2度交叉验证 ... |
| comments | string | 备注 |
- 返回样例：
{"msg":[{"comments":"用于测试","crossChecked":0,"eventDatetime":"2020-12-17T07:26:54Z","eventId":601897866100782,"eventName":"测试event","eventStatus":0,"eventTypeId":1,"isComplete":false,"isDiscard":true,"proId":587981966540846},{"comments":"用于测试","crossChecked":0,"eventDatetime":"2020-12-17T07:26:54Z","eventId":601897948938286,"eventName":"测试event","eventStatus":0,"eventTypeId":1,"isComplete":false,"isDiscard":false,"proId":587981966540846},{"comments":"用于测试","crossChecked":0,"eventDatetime":"2021-01-15T05:29:07Z","eventId":3221799931215918,"eventName":"测试event","eventStatus":0,"eventTypeId":1,"isComplete":false,"isDiscard":true,"proId":3212782118895662},{"comments":"用于测试","crossChecked":0,"eventDatetime":"2021-01-15T05:29:07Z","eventId":3221800013004846,"eventName":"测试event","eventStatus":0,"eventTypeId":1,"isComplete":false,"isDiscard":false,"proId":3212782118895662}],"code":0}- URL:
/api/proof-list
- 参数：
| 参数名 | 解释 | 例 |
|---|---|---|
| pvId | 可选参数；找到该pvId的数据 | 123 |
| eventId | 可选参数；用于找到所有属于eventId的存证实例 | 123 |
| token | 机构的API账户标志 | A57EF12783BC2 |
| datetime | 调用时间（UTC时间） | 2020-01-22T09:12:43Z |
| signature | 机构的数字签名的Base64编码 | RGlnaXRhbCBTaWduYXR1cmUgRXhhbXBsZQ== |
-
签名字段：
- pvId（如果不填该参数，签名时将其值设为null）
- eventId（如果不填该参数，签名时将其值设为null）
- token
- datetime
-
返回字段：
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| pvId | long | 证据识别编号 |
| eventId | int | 事件实例的ID |
| pvType | string | 证据类型。例：哈希摘要，文档，数字协议等 |
| contentHash | string | content二进制的哈希值（也就是java中byte[]的哈希值） |
| deltaFitSign | string | 得分的签名 |
| isOnBC | boolean | 是否上链 |
| blockHash | string | 区块哈希摘要 |
| operator | string | 操作人 |
| operatorSign | string | 操作人签名 |
| docId | string | 相关文档索引数据库识别号 |
| docName | string | 文档的文件名 |
| cParty1 | string | 证据甲方代码 |
| cParty2 | string | 证据乙方代码 |
| cParty3 | string | 证据丙方代码 |
| cParty4 | string | 证据丁方代码 |
| pvStatus | byte | 存证状态。0=无效 1=有效 2=2维交叉验证 3= 3维交叉验证 等 |
| examId | long | 交叉验证记录识别号 |
| comments | string | 备注 |
| operateDatetime | string | 操作时间（UTC时间字符串） |
- 返回样例：
{"msg":[{"blockHash":"","cParty1":"企业01","cParty2":"企业02","cParty3":"企业03","cParty4":"企业04","comments":"备注","contentHash":"gHjSXz5b53K1aHtzc/5NEn3MSiI4NL/51j6SqTG8nqE=","deltafitSign":"","docId":"文档编号01","eventId":3225056701317166,"examId":-1,"isOnBc":false,"operateDatetime":"2021-01-15T06:24:15Z","operator":"张三","operatorSign":"1234567890","originalDocName":"contract.pdf","pvId":3225268732821550,"pvStatus":0,"pvType":"哈希摘要"}],"code":0}- URL:
/api/create-proof
- 参数：
| 参数名 | 解释 | 例 |
|---|---|---|
| eventId | 事件编号 | 123 |
| pvType | 证据类型。可选值：哈希摘要，文档，数字协议 | 哈希摘要 |
| content | 文档或哈希摘要的Base64（byte[]长度不应该超过200MB） | RGlnaXRhbCBTaWduYXR1cmUgRXhhbXBsZQ== |
| contentHash | content二进制的哈希值（也就是java中byte[]的哈希值） | RGlnaXRhbCBTaWduYXR1cmUgRXhhbXBsZQ== |
| cParty1 | 非必填，证据甲方代码 | |
| cParty2 | 非必填，证据乙方代码 | |
| cParty3 | 非必填，证据丙方代码 | |
| cParty4 | 非必填，证据丁方代码 | |
| operator | 操作员代码 | 张三 或 22603 |
| operatorSign | 非必填，操作员的对contentHash的数字签名Base64 | RGlnaXRhbCBTaWduYXR1cmUgRXhhbXBsZQ== |
| comments | 备注 | 合同正文 |
| docId | 文档编号（pvType=文档）时需要传入 | 4616189191 |
| originalDocName | 文档的原始（pvType=文档）时需要传入 | 合同.pdf |
| token | 机构的API账户标志 | 417fXkWTP85uE8LXZH9nqCZn3r3JjsTl |
| datetime | 调用时间（UTC时间） | 2020-01-22T09:12:43Z |
| signature | 机构的数字签名的Base64编码 | MIGIAkIB8HKnnrj5tMwEPVC... |
-
签名字段：
- eventId
- pvType
- contentHash
- cParty1
- cParty2
- cParty3
- cParty4
- operator
- operatorSign
- comments
- docId
- originalDocName
- token
- datetime
-
返回字段：
- 成功：pvId
- 失败：失败原因
-
返回样例：
{"msg":3225268732821550,"code":0}- URL:
/api/create-event
- 参数：
| 参数名 | 解释 | 例 |
|---|---|---|
| proId | 流程实例的ID | 123 |
| eventTypeId | 事件类型的ID | 123 |
| eventName | 事件实例的名称。命名规则：融资方代号_事件的融资方内部编号_日期 | 110033_009816_20201123 |
| discardEventId | 可选参数；如果此proId 的eventTypeId已经创建过一个事件实例，说明本次调用是对原来的事件实例有修改，需要传入此参数，用于将旧版的事件实例丢弃 | 123 |
| comments | 备注 | 合同 |
| token | 机构的API账户标志 | 417fXkWTP85uE8LXZH9nqCZn3r3JjsTl |
| datetime | 调用时间（UTC时间） | 2020-01-22T09:12:43Z |
| signature | 机构的数字签名的Base64编码 | MIGIAkIB8HKnnrj5tMwEPVC... |
- 签名字段：
- proId
- eventTypeId
- eventName
- discardEventId
- comments
- token
- datetime
- 返回字段：
- 成功：proId
- 失败：失败原因
- 返回样例：
{"msg":3225421538656302,"code":0}将所有字段内容，按照每个接口中“签名字段”的key排序（升序）进行字符串拼接，中间不需要任何分隔符。如果可选字段不设置，则用字符串""(不含双引号)填充（即长度为0的字符串）使用SHA512-ECDSA算法进行签名。
注意：为防止重放攻击，如果服务端收到两条或两条以上的相同接口、相同datetime的请求，仅会执行第一条，其余的请求会被丢弃。
使用openssl工具，在linux的控制台执行：
# 私钥生成
openssl ecparam -name secp521r1 -genkey -noout -out private.pem
# 公钥生成
openssl ec -in private.pem -pubout -out public.pem<dependency>
<groupId>org.bouncycastle</groupId>
<artifactId>bcprov-jdk15on</artifactId>
<version>1.67</version>
</dependency>
<dependency>
<groupId>org.bouncycastle</groupId>
<artifactId>bcpkix-jdk15on</artifactId>
<version>1.67</version>
</dependency>class Demo {
public static void main(String[] args) {
String privateStr = "-----BEGIN EC PRIVATE KEY-----\n" +
"MIHcAgEBBEIB7HKA4LlfQAE3P/p7deFeZttQzp5qGmUSx2YRxnpSqkqP9U3hD5I4\n" +
"yuj6pfAr/KbfOHJ1Nd36e+vxEq5zR6tfvvagBwYFK4EEACOhgYkDgYYABABPDG3I\n" +
"gL4u1KBudkH0whHjInK/aF0BhGGY0GuNlxtlMyksMaNIehJWA7GAyAC0qBKYAKrn\n" +
"izGh+5Vbwo4vhpEp7AG5IDElnH2Dy9HvtYEDysWm5LhgRtPirTtIKrNT30vNBZXW\n" +
"cnaC2ZIasyltnvTwXPZypAAPTYfD0nqvqq4aPuRJAQ==\n" +
"-----END EC PRIVATE KEY-----";
// 加载BouncyCastle
Security.addProvider(new BouncyCastleProvider());
// 读取私钥pem，这里也可以选择从文件读取
PEMParser privatePemParser = new PEMParser(new StringReader(privateStr));
PEMKeyPair pemKeyPair = (PEMKeyPair) privatePemParser.readObject();
// 将私钥pem转为privateKey
JcaPEMKeyConverter converter = new JcaPEMKeyConverter();
KeyPair keyPair = converter.getKeyPair(pemKeyPair);
ECPrivateKey privateKey = (ECPrivateKey)keyPair.getPrivate();
// 签名
Signature signature = Signature.getInstance("SHA512withECDSA");
byte[] data = "这里是需要被签名的字符串".getBytes(StandardCharsets.UTF_8);
signature.initSign(privateKey);
signature.update(data);
byte[] result = signature.sign();
// 签名转为Base64
String signatureBase64 = Base64.getEncoder().encode(result);
}
}返回值都为JSON格式，如下：
{"code": code, "msg": ...}
其中：
- code：0表示成功，其它整数为错误
- msg：按照每个接口“返回字段”中的数据结构返回
- URL：
http://124.71.46.57:8080/
- 公钥：
-----BEGIN PUBLIC KEY-----
MIGbMBAGByqGSM49AgEGBSuBBAAjA4GGAAQATwxtyIC+LtSgbnZB9MIR4yJyv2hd
AYRhmNBrjZcbZTMpLDGjSHoSVgOxgMgAtKgSmACq54sxofuVW8KOL4aRKewBuSAx
JZx9g8vR77WBA8rFpuS4YEbT4q07SCqzU99LzQWV1nJ2gtmSGrMpbZ708Fz2cqQA
D02Hw9J6r6quGj7kSQE=
-----END PUBLIC KEY-----
- 私钥：
-----BEGIN EC PRIVATE KEY-----
MIHcAgEBBEIB7HKA4LlfQAE3P/p7deFeZttQzp5qGmUSx2YRxnpSqkqP9U3hD5I4
yuj6pfAr/KbfOHJ1Nd36e+vxEq5zR6tfvvagBwYFK4EEACOhgYkDgYYABABPDG3I
gL4u1KBudkH0whHjInK/aF0BhGGY0GuNlxtlMyksMaNIehJWA7GAyAC0qBKYAKrn
izGh+5Vbwo4vhpEp7AG5IDElnH2Dy9HvtYEDysWm5LhgRtPirTtIKrNT30vNBZXW
cnaC2ZIasyltnvTwXPZypAAPTYfD0nqvqq4aPuRJAQ==
-----END EC PRIVATE KEY-----
- token:
417fXkWTP85uE8LXZH9nqCZn3r3JjsTl