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

前期准备
参考文档《永旗新建联盟链》(点击即可进入)的“前期准备——异步通知返回描述”部分。

1.溯源商品管理

2.溯源码管理

3.环节管理

永旗 API 接口
溯源接口说明
1.查询商品列表
根据商品编号,商品名称,商品品牌,溯源码标识查询用户的商品列表
服务名称
api.source.queryGoods
请求业务参数

返回业务数据

list 集合相应参数

示例
业务参数示例

2.批量创建商品
创建溯源商品
服务名称
api.source.addGoods
请求业务参数

goodsList 集合对象参数

返回业务数据
data 响应参数

示例

3.批量修改商品
批量修改未创建溯源码商品,已创建溯源码不能修改。
服务名称
api.source.editGoods
请求业务参数

goodsList 集合对象参数

返回业务数据
集合响应参数

示例


4.查询溯源码记录
根据溯源码编号,商品批次,商品编码,商品名称,创建时间查询溯源码列表
服务名称
api.source.queryCodes
请求业务参数

响应业务数据

list 集合响应参数

示例

5.生产溯源码
批量生产溯源码
服务名称
api.source.createCodes
请求业务参数

响应业务数据
集合响应参数

示例


6.下载溯源码
查询溯源码二维码图片的下载地址
服务名称
api.source.downCodes
请求业务参数

响应业务数据
集合响应参数

示例

7.获取环节模板列表
通过环节模板名称,编号,查询环节模板
服务名称
api.source.queryTemplateNodes
请求业务参数

响应业务数据
集合响应参数

templateProcessList 环节

templateProcessDetailList 环节字段

示例


8.创建环节模板
服务名称
api.source.createTemplateNodes
请求业务参数

addTemplateProcessList 环节

addTemplateProcessDetailList 环节字段

响应业务数据
集合响应参数

templateProcessList 环节

templateProcessDetailList 环节字段

示例

{
"templateProcessId": "aec0d9e4138b4304b1e7ce5763f35019",
"templateProcessName": "测试",
"templateProcessDetailList": [
{
"templateProcessDetailId": "f6b41dc5fab149bdb7d401432f34c70a",
"templateProcessFieldName": "节点",
"templateProcessFieldType": "String",
"templateProcessFieldRemark": "",
"updateBy": "aixuekui2008abc@163.com"
}
]
}
]
}
}
9.上传溯源环节数据
上传溯源环节数据,并链上存证。
服务名称
api.source.uploadDetail
请求业务参数

addTraceDataProcessDetailList 环节内容

响应业务数据

traceProcessDetailList 存证溯源数据

traceDataDetailList 环节数据

示例


10.查询溯源存证
根据存证交易 ID 或溯源码编号(二选一),查询已上链的溯源存证编号。
服务名称
api.source.sureGoodCode
请求业务参数

响应业务数据
集合响应参数

traceProcessDetailList 存证溯源数据

traceDataDetailList 环节数据

示例


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

结语
结语
欢迎广大企业机构及个人开发者,成为VBH开发者中心会员,调用体验永旗溯源链接口。
VBH开发者中心会员注册链接:
https://con.vbhledger.com/login/index
下期预告:永旗版权链开发文档。


