开源有你，协作共赢 | 永旗开放联盟链

永旗VBH底层技术已经全面落地并铺向市场，我们致力于提供多种区块链API接口服务，满足开发者不同的开发体验与需求。接下来，我们将着重介绍永旗VBH开发者中心的API开发者文档，干货满满，欢迎阅览。

永旗 API 开发者文档，为用户提供了丰富的区块链交互接口，开发者可以方便快捷的调用这些API 完成任务。目前永旗 API 提供了开放联盟链、版权链、积分链、供应链金融、溯源链等多种区块链服务。（本次，永旗 API 仅提供开放联盟链接口说明。）

  开发流程

  前期准备

在开发之前，您需要完成下列准备工作。

在平台上申请创建接口所需的 AccessKey 与 AccessSecret，用于接口交互。

购买相关产品，并生成上链证书。上链证书，可以用来验证链上数据。 

  注意事项

·用户 KEY（AccessKey）用于标识用户，调用 API 接口时作为请求参数。

·权限验证（AccessSecret）由开发者自己保存，需填写到代码中供签名时使用。

·生成的私钥需妥善保管，避免遗失，不要泄露。

  签名

开发者可以通过签名进行了解签名生成后的 sign，此时可以和自己代码中请求生成的信息进行对比了解数据是否正确。此处主要介绍使用进行签名的方法。

  规则

Sign 签名，调用 API 时需要对请求参数（包含请求头参数，公共请求参数，业务参数）进行签名验证，签名方式如下：

1. 按照请求参数名称将所有请求参数（不包括字节类型参数，如文件、字节流，剔除 sign 字段，剔除值为空的参数）按照第一个字符的键值 ASCII 码递增排序（字母升序排序），如果遇到相同字符则按照第二个字符的键值 ASCII 码递增排序，以此类推；将排序后的参数与其对应值，组合成 参数=参数值 的格式，并且把这些参数用 & 字符连接起来，此时生成的字符串为待签名字符串（以下 str 代替待加密字符串）。

示 例 ： a=123&b=123&c=123

1. 将 AccessSecret 加在参数字符串的尾部。

示例：str&secret=90015098*************28E17F72

2. 进行 MD5 加密 ,加密后的字符串即为 sign。

示例：MD5(str&secret=90015098*************28E17F72)

  服务器地址

测试接口地址

https://sim-api-cloud./v1/api/gateway

线上接口地址

https://api-cloud./v1/api/gateway

  交互方式

永旗 API 支持基于 URL 发送 HTTP/HTTPS 请求。所有请求都为 POST 请求，请求参数为 JSON 格式， 请求及返回结果都使用 UTF-8 字符集编码。

  公共请求头参数

  公共请求参数

描述

公共请求参数，每次接口请求都必须带入，业务级别参数详情见具体接口描述

  同步响应/异步通知参数

描述

永旗 API，响应参数固定，业务级别参数均以 JSON 对象的形式赋值在 data 参数中。建议使用异步通知模式调用。

示例

响应参数：

{

'code': 10000, 

'msg': 'success', 

'data': null

}

异步通知返回描述

三方平台收到异步通知后，需要返回参数

  1.存证

  2.查询核验

永旗 API 接口

开放联盟链接口说明

  1.存证并上链

发起存证请求，获取存证交易号，并可以直接数据上链。

服务名称

api.evidence.confirm.info 

请求业务参数

返回业务数据

示例

业务参数示例

{

'initInformation':'123444', 

'isCommit':true, 

'informationValue':'123',

}

正常返回示例

{

'code':10000, 

'msg':'success',

'data':{

' requestNo ':1000009,

' inforId':'2443db4f14f046449d4e138a2aa4dd1a', ' commitId':'************************',

}

]

}

}

 2. 存证上链

可以对已生产的存证交易号，进行内容上链，上链数据不可修改 证据上链结果可以通过主动查询获取。

服务名称

api.evidence.confirm.chain 

请求业务参数

返回业务数据

示例

业务参数示例

{

'inforId':'20000D5E00000000000007FC',

'informationValue':'informationValue',

}

正常返回示例

{

'code':10000, 

'msg':'success', 

'data':{

'requestNo':1000009,

'inforId':'2443db4f14f046449d4e138a2aa4dd1a', 

'commitId':'************************'

}

]

}

}

 3.保全号核验

可以对已生产的存证交易号，进行内容上链，上链数据不可修改 证据上链结果可以通过主动查询获取。

服务名称

api.evidence.confirm.verify 

请求业务参数

返回业务数据

示例

业务参数示例

{

'param':'20000D5E00000000000007FC'

}

正常返回示例

{

'code':10000, 

'msg':'success', 

'data':{

'info':'************************',

'requestNo':'9e7e3d1eb77c4abfab4072cd0fec3dbf'

}

]

}

}

 4.查询区块高度

获取当前区块高度.

服务名称

api.evidence.query.count

请求业务参数

返回业务数据

示例

业务参数示例

{

'isQuery': true

}

正常返回示例

{

'code':10000, 

'msg':'success', 

'data':{

' requestNo ': ' ***************************** ', 

' blockCount ':123,

}

]

}

}

 5.查询区块信息

根据区块高度，查询区块的详细信息

服务名称

api.evidence.query.block

请求业务参数

返回业务数据

示例

业务参数示例

{

'blockId': 1,

}

正常返回示例

{

'code':10000,

'msg':'success',

'data':{

'blockID':999,

'timeStamp':'2021-02-1812:29:23', 'preHash':'023645B24E0BBC5BDDEEAAA79CFACE05A0382D7F119F4588EF5438F96CABF8D2',

'transCount':1, 'transactionMroot':'30D33AEE81621DDF98D7B837A5CC742BA4636F46707367D6B277C954E3378BD8'

}

]

}

}

 响应码表

API 调用失败时，会返回对应的异常错误码。您可以对照以下错误码信息，查找解决方法。

结语

欢迎广大企业机构及个人开发者，成为VBH开发者中心会员，调用体验永旗开放联盟链接口。

VBH开发者中心会员注册链接：

https://con./login/index

下期预告：永旗溯源链开发文档。