开发者文档

中国完全自主知识产权,金融级区块链解决方案

立刻成为开发者
什么是太一公有云开发者平台

太一公有云开发者平台基于太一区块链技术,将开发上层应用所需要的功能组件进行封装,通过开放接口,将自己的系统、数据等释放给第三方合作伙伴及企业内部开发者,使其更便捷地实现对应功能。共同打造新一代的公共可信区块链服务。

平台同时提供开发者运维所需要的工具。(区块链浏览器,大数据查询中心等)

如何成为开发者

为了保护太一公有云用户的数据,防止API被滥用或恶意使用,太一公有云要求每个API的使用者必须安装太一可信认证APP注册并进行实名认证,之后方可申请成为开发者,并且会分配给每个开发者唯一的APP ID 和APP Secret。作为开发者的唯一标识

1 进入https://cloud.taiyiyun.com 下载并安装可信认证APP。(详情请见:可信认证新手指南)

2 申请成为开发者,使用太一可信认证账号扫码授权登录或输入账号授权登录。

3 登录成功之后,得到唯一标识APP ID 和 Secret,说明已经获得授权。

4 开发者需要输入APP Key,用于与接口进行签名使用。APP Key 可以更改。

5 成为开发者后便可根据开发者文档进行API调用。

太一公有云开发者平台公约

第一章 总则
第一条

太一公有云开发者平台(以下简称“本平台”)基于太一区块链技术,构建自由开放的数字资产管理系统,向用户提供丰富应用API和完善服务的开放平台。为了构建和谐共存的生态体系,实现平台、伙伴和用户的共赢,特制定本公约。

第二条

本公约所称第三方合作伙伴(以下简称“第三方”或“开发者”),指在太一公有云开发者平台合作接入API,向个人或企业提供服务的第三方。

第三条

凡是接入本平台API的开发者,将视为已同意《太一公有云开发者平台公约》中的所有条款和内容。

第二章 开发者行为准则
第四条

开发者使用本平台上的API接口,不得用于任何违反国家法律法规政策规章的应用。

第五条

开发者须遵守本平台的隐私保护条款,对于本平台提供的全部数据及资源,开发者仅用于接入自有应用,不得用于其它任何用途使用,未经本平台书面同意,开发者不得将上述信息及资源披露给任何第三方,否则,本平台有权利随时终止合作并追究开发者的赔偿责任。

第三章 业务范围
第六条

本平台和开发者分工合作,共同完善和丰富太一公有云的功能,为用户提供更好的体验和服务。

第七条

太一公有云将专注于核心功能、平台基础服务及重点产品(包括但不限于数字资产管理,行业应用管理,数据管理,工具管理),将不对外部第三方开放。

第八条

对于具有法律风险、需要监管的行业,本平台将根据调研结果,判断是否授权合作。

第四章 开发者的权益
第九条

对于所有本平台的开发者,本平台将遵循平等、公平的原则,向开发者提供开发所必须的资源,如数据接口、技术文档、客服支持等。

第五章 附则
第十条

本平台以提供学习和了解区块链为目的,向开发者开放API接口。本平台坚决贯彻国家反洗钱和反非法集资的政策法规,对各类违法犯罪活动进行有效监控,如发现违法犯罪的线索,将立即向国家有关机关汇报并举证。请广大开发者合法合规使用,禁止一切违法违规行为,为此造成的所有后果将由用户自行承担。

第十一条

本平台会根据太一公有云不同阶段的整体战略,通过聆听开发者、用户的需求,不断完善该公约。一旦本公约的内容发生变动,本平台将会直接在网站上公布修改之后的公约内容,该公布行为视为本平台已经通知开发者修改内容。本平台也可通过其他适当方式向开发者提示修改内容。

第十二条

本公约自2017年1月1日起执行。

公共API

主要功能:数字资产发行,数字资产转移及数字资产查询三部分功能。

面向用户群:一般开发者,区块链技术人员,区块链研究爱好者。

主要目的:使用户可以快速构建自己的数字资产,与太一公有云共同促进区块链行业的稳健发展。

1、说明

URL里面的中文参数采用UTF-8编码,使用URLEncode进行中文数据的编码处理。如无特别说明,API的基本路径为:https://api.taiyiyun.com/basis/

如需签名,则签名规则为:[参数=参数值],按照升序进行排列后拼接起来,最后加上key=[APP Key]进行MD5摘要算法生成签名,签名结果需为大写。

2、获取token

token是太一公有云开发者平台的唯一标识,开发者调用接口时都需要使用。

token的有效期为1个小时,日均调用上限为2000次,开发者需进行全局缓存使用。重新获取后上次获取的token将失效。

2.1 https请求方式:get

接口地址:https://api.taiyiyun.com/basis/?taiyiyun.api=api.common.token&app_id=appId&secret=secret&sign=sign

2.2 参数说明
参数 说明
app_id 开发者唯一凭证,申请成为开发者后获得。
secret 开发者唯一密钥,申请成为开发者后获得。
Sign 使用开发者加密字符串(APP Key)进行的签名。
注:请求时需要在 header 里 Content-Type 的值设置为 application/x-www-form-urlencoded。
2.3 服务器响应

示例

  • 成功
  • {
  • "success" : true,
  • "token" : "590ae053c7114c8fbb65a003142f19ef",
  • "expire_time" : 3600
  • }
  • 失败
  • {
  • "success" : false,
  • "message" : "签名错误"
  • }
2.4 服务器响应说明
参数 说明
success 成功失败标识。      true:成功 | false:失败
token 当success=true时,返回正常的token。当success=false时,返回空值。
expire_time 表示token的有效期。
success=true时,返回有效期时间,默认是3600秒。当success=false时,返回空值。
message 表示获取token失败原因。
当success=true时,返回空值。当success=false时,返回失败的原因。
3、发行数字资产(异步)

开发者可以通过该接口提交发行数字资产的信息,经工作人员审核完成后,将发行到太一区块链上。

3.1 https请求方式:post

接口地址:https://api.taiyiyun.com/basis/?taiyiyun.api=api.basis.issue&token=token

post请求数据格式:json

post请求数据示例:

  • {
  • "asset_name" : "云梦数字资产",
  • "asset_symbol" : "YMC",
  • "asset_unit" : "个",
  • "asset_amount" : 100000,
  • "asset_desc" : "云梦数字资产是用于实物资产通用兑换的一种货币",
  • "asset_fee" : 0.0001ABC,
  • "asset_metadata": "云梦数字资产发行总量为100000,初始发行50000,以后每月发行为前月的一半,最小发行500,直至总量为100000"
  • }
3.2 参数说明
参数 说明
asset_name 数字资产中文名称,6个以内汉字。
asset_symbol 数字资产的英文符号,5个以内大写字母。
asset_unit 数字资产单位。
asset_fee 转账交易手续费。[默认:0.0001ABC]
asset_desc 数字资产描述。
asset_amount 发行数字资产总数量。
asset_metadata 扩展解释说明。[可为空]
注:请求时需要在 header 里 Content-Type 的值设置为 application/json,并使用URLEncode进行编码。
3.3 服务器响应

示例

  • 成功:
  • {
  • "success" : true,
  • "issue_no" : "590ae053c7114c8fbb65a003142f19ef",
  • "issue_state" : 0,
  • "asset_symbol": "YMC",
  • "reject_data":"驳回的原因"
  • }
  • 失败:
  • {
  • "success" : false,
  • "message" : "数字资产YMC已经发行"
  • }
3.4 服务器响应说明
参数 说明
success 成功失败标识。      true:成功 | false:失败
issue_no 发行序列号,唯一性。 当success=true时,返回发行序列号。当success=false时,返回空值。
issue_state 资产发行的状态:0代表“未审核”,10代表“审核通过”[但未发行],11代表“已发行”,2代表“驳回”。
reject_data 表示驳回申请的原因。
asset_symbol 数字资产的英文符号。
message 资产发行失败原因。当success=true时,返回空值。当success=false时,返回失败的原因。

开发者可以通过该接口查询数字资产的发行状态,分别为未审核,审核通过,已发行,驳回。

4.1 https请求方式:get

接口地址:https://api.taiyiyun.com/basis/?taiyiyun.api=api.basis.issue.state&token=token&issue_no=issueno&asset_symbol=asset_symbol

4.2 参数说明

issue_no与asset_symbol不能同时为空。必须使用其中一项进行资产状态查询。

参数 说明
issue_no 发行序列号,唯一性。
asset_symbol 数字资产的英文符号。
注:请求时需要在 header 里 Content-Type 的值设置为 application/x-www-form-urlencoded。
4.3 服务器响应

示例

  • 成功:
  • {
  • "success" : true,
  • "issue_no" : "590ae053c7114c8fbb65a003142f19ef",
  • "issue_state" : 0,
  • "asset_symbol": "YMC",
  • "issue_address": "1N4U2dURX11Dk8fqexsKi3yVLjKFZi22s4"
  • }
  • 失败:
  • {
  • "success" : false,
  • "message" : "token已过期"
  • }
4.4 服务器响应说明
参数 说明
success 成功失败标识。      true:成功 | false:失败
issue_no 发行序列号,唯一性。 当success=true时,返回发行序列号。当success=false时,返回空值。
issue_state 资产发行的状态:0代表“未审核”,10代表“审核通过”[但未发行],11代表“已发行”,2代表“驳回”。
asset_symbol 数字资产的英文符号。
message 查询失败原因。当success=true时,返回空值。当success=false时,返回失败的原因。
issue_address 资产发行的初始地址。
5、数字资产转移

开发者可以通过本接口来完成数字资产的转移。可以发送数字资产到其他地址。

5.1 https请求方式:post

接口地址:https://api.taiyiyun.com/basis/?taiyiyun.api=api.basis.send&token=token

post请求数据格式:json

post请求数据示例:

  • {
  • "asset_symbol" : "YMC",
  • "send_amount" : 1000.00,
  • "from_address" : "1N4U2dURX11Dk8fqexsKi3yVLjKFZi22s4",
  • "to_address" : "1MPBykJVHAvVQhHvdMyhZVM3LAfHNpvvez",
  • "send_metadata": "给XXX的转账",
  • "trade_no":"201611030001",
  • "sign":"770ea93d978c47d99bbf3c9e4a2a78d7"
  • }
5.2参数说明
参数 说明
asset_symbol 数字资产的英文符号。
send_amount 转移数字资产金额。注:需要格式化为小数点后8位。例如:1000.00格式化后应为:1000.00000000
from_address 发送数字资产地址。
to_address 接收数字资产地址。
send_metadata 转移说明。[可为空]
trade_no 交易序列号。[开发者需要保证其唯一]
sign 签名。
签名规则:asset_symbol=[asset_symbol]send_amount=[send_amount]from_address=[from_address]to_address=[to_address]trade_no=[trade_no]key=[key]MD5摘要算法签名。
注:1 请求时需要在 header 里 Content-Type 的值设置为 application/json,并使用URLEncode进行编码。
5.3 服务器响应

示例

  • 成功:
  • {
  • "success" : true,
  • " txid" : "78af8248e653e36a165abbcfdf45774978d17dced469f33fcd837a1933d8bafa",
  • "send_amount " : 1000.00,
  • "asset_symbol": "YMC",
  • "from_address" : "1N4U2dURX11Dk8fqexsKi3yVLjKFZi22s4",
  • "to_address" : "1MPBykJVHAvVQhHvdMyhZVM3LAfHNpvvez",
  • "trade_no":"201611030001"
  • }
  • 失败:
  • {
  • "success" : false,
  • "message" : "token已过期"
  • }
5.4 服务器响应说明
参数 说明
success 成功失败标识。      true:成功 | false:失败
txid 区块链交易ID。当success=true时,返回区块链交易ID。当success=false时,返回空值
send_amount 转移数字资产金额。
asset_symbol 数字资产的英文符号。
from_address 发送数字资产地址。
to_address 接收数字资产地址。
trade_no 交易序列号。
message 表示资产转移失败原因。当success=true时,返回空值。当success=false时,返回失败的原因
6 资产新地址获取

开发者可通过该接口获取已发行资产的新地址。新地址的获取分钟限制只能获取5个地址。开发者应合理安排使用。

6.1 https请求方式:get

接口地址:https://api.taiyiyun.com/basis/?taiyiyun.api=api.basis.address&token=token&asset_symbol=asset_symbol

6.2 参数说明
参数 说明
asset_symbol 数字资产的英文符号。
注:请求时需要在 header 里 Content-Type 的值设置为 application/x-www-form-urlencoded。
6.3 服务器响应

示例

  • 成功:
  • {
  • "success" : true,
  • "address" : "1MPBykJVHAvVQhHvdMyhZVM3LAfHNpvvez",
  • "asset_symbol": "YMC"
  • }
  • 失败:
  • {
  • "success" : false,
  • "message" : "token已过期"
  • }
6.4 服务器响应说明
参数 说明
success 成功失败标识。      true:成功 | false:失败
address 获取到的新地址。当success=true时,返回新地址。当success=false时,返回空值。
asset_symbol 数字资产的英文符号。
message 表示资产转移失败原因。当success=true时,返回空值。当success=false时,返回失败的原因
7 获取区块链资产信息

开发者可通过该接口查询自有账户下的所有资产信息。

7.1 https请求方式:get

接口地址:https://api.taiyiyun.com/basis/?taiyiyun.api=api.basis.info&token=token

7.2 服务器响应

示例

  • 成功:
  • {
  • "success" : true,
  • "assets" : [{
  • "asset_symbol" : "YMC",
  • "asset_address" :"1N4U2dURX11Dk8fqexsKi3yVLjKFZi22s4 "
  • "asset_amount" :100.00
  • }, {
  • "asset_symbol" : "YMC",
  • "asset_address" : "1MPBykJVHAvVQhHvdMyhZVM3LAfHNpvvez",
  • "asset_amount" :100.00
  • }]
  • }
  • 失败:
  • {
  • "success" : false,
  • "message" : "token已过期"
  • }
7.3 服务器响应说明
参数 说明
success 成功失败标识。      true:成功 | false:失败
asset_symbol 数字资产的英文符号。
asset_address 数字资产的地址。
asset_amount 在该地址上的资产数量。
message 表示获取资产信息失败原因。当success=true时,返回空值。当success=false时,返回失败的原因。
8.区块链交易信息查询(数字资产公示提供)
8.1 http请求方式:get

接口地址:http://explorer.taiyiyun.com/api/v1/tx/{txid}

8.2 参数说明
参数 说明
txid 数字资产的区块链交易ID。
注:请求是需要在 header 里 Content-Type 需要设置 application/x-www-form-urlencoded
8.3 服务器响应

示例

  • 成功:
  • {
  • "assetType": "Coin",
  • "blockHeight": 655012,
  • "blockTime": 1477878343000,
  • "cnAssetType": "数字货币",
  • "cnName": "云梦(YMC)",
  • "fee": "0",
  • "id": 696837,
  • "inputs": [{
  • "address": "14tW5SKAqhoSWGR9YyutBxxdAaxzhZuLnp",
  • "amount": 0.0007
  • }],
  • "outputs": [{
  • "address": "14tW5SKAqhoSWGR9YyutBxxdAaxzhZuLnp",
  • "amount": 0.0006,
  • "txid": "249ab17861fd2ac0257db309de69bcac9707fb4a299d3ae39e010ec7f02c3e32"
  • },{
  • "address": "1Rmu6RbpCWMr1sHuUgdn5B1u4ExN6UVcn",
  • "amount": 0.0001,
  • "txid": "249ab17861fd2ac0257db309de69bcac9707fb4a299d3ae39e010ec7f02c3e32"
  • }],
  • "size": "226",
  • "sizeKb": "0.226",
  • "symbol": "YMC",
  • "totalIn": "0.0007",
  • "totalOut": "0.0007",
  • "txid": "249ab17861fd2ac0257db309de69bcac9707fb4a299d3ae39e010ec7f02c3e32",
  • "unit": "个"
  • }
  • 失败:
  • {
  • "success" : false,
  • "message" : "交易ID有误"
  • }
8.4 服务器响应说明
参数 说明
assetType 数字资产的类型。
blockHeight 区块高度。
blockTime 区块时间戳。
cnAssetType 数字资产类型中文名称。
cnName 数字资产中文名称。
fee 交易手续费。
inputs 交易输入。
address 输入/输入地址。
amount 输入/输入数字资产数量。
outputs 交易输出。
size 区块大小(字节)。
sizeKb 区块大小(KB)。
symbol 数字资产的英文符号。
totalIn 总输入。
totalOut 总输出。
txid 交易序列号。
unit 数字资产单位。
message 表示查询交易信息失败原因。当success=true时,返回空值。当success=false时,返回失败的原因。
行业应用API

主要功能:版权登记转让。

面向用户群:版权作者,著作权人,版权平台。

主要目的:在区块链上进行确权,不可篡改,支持追踪溯源。保护版权所有者的合法权益。

版权管理是基于区块链技术,将作品信息、版权所有人信息、版权实体二进制流打包成为一个64位hash值,将hash值和版权信息登记在区块链上,若版权信息发生了更改,则可生成新的hash值,所有的数据都支持追踪溯源。同时可使用业务流水号,查询版权详细信息。

1.1 获取token

token是太一公有云开发者平台的唯一标识,开发者调用接口时都需要使用。

token的有效期为1个小时,日均调用上限为2000次,开发者需进行全局缓存使用。重新获取后上次获取的token将失效。

1.1.1 https请求方式:get

接口地址:https://api.taiyiyun.com/copyright?token=token&taiyiyun.api=api.common.token&app_id=appId&secret=secret&sign=sign

1.1.2 参数说明
参数 说明
app_id 开发者唯一32位凭证,申请成为开发者后获得。
secret 开发者唯一32位密钥,申请成为开发者后获得。
sign 使用私钥进行数据的签名。
1.1.3 服务器响应

示例

  • 成功:
  • {
  • "success" : true,
  • "token" : "590ae053c7114c8fbb65a003142f19ef",
  • "expire_time" : 3600
  • }
  • 失败:
  • {
  • "success" : false,
  • "message" : "签名错误"
  • }
1.1.4 服务器响应说明
参数 说明
success 成功失败标识。      true:成功 | false:失败
token 当success=true时,返回正常的token。当success=false时,返回空值。
expire_time 表示token的有效期。
当success=true时,返回有效期时间,默认是3600秒。当success=false时,返回空值。
message 表示获取token失败原因。
当success=true时,返回空值。当success=false时,返回失败的原因。
1.2 版权登记

开发者可通过该接口进行版权信息登记,记录在区块链上。

1.2.1 https请求方式:post

接口地址:https://api.taiyiyun.com/copyright/?token=token&taiyiyun.api=api.copyright.register

post数据格式:json

post请求数据示例

  • {
  • “business_num” : “12342432434332cdffdsdffdfdf”,
  • “hash” : “asdfdfdsfeererreg121323435436576574846787847864754532421fdd” ,
  • “work_type” : “美术作品”,
  • "author" : ”张三”,
  • “work_name” : “蔚蓝的天空” ,
  • “copyright_owner” : “张三” ,
  • “finish_time” : “2016年03月05日” ,
  • “first_pubtime” : “2016年04月05日” ,
  • “regist_time” : “2016年05月04日 12:12:12” ,
  • “abstract”:”该作品采用油墨结合风格进行创作”,
  • “custom_detail” : “自定义类型”,
  • “work_link”:www.huaban.com/12345,
  • “work_content”:一只小鸟在蔚蓝的天空翱翔
  • }
1.2.2 参数说明
参数 说明
token 授权token
business_num 业务系统唯一32位以内流水号
hash 版权原数据64位hash值
work_type 版权类型(从大类到小类组合)
author 作品作者
work_name 作品名称
copyright_owner 著作权人
finish_time 著作完成时间
first_pubtime 首次发表时间
regist_time 登记时间
copy_abstract 版权摘要
custom_detail 版权用户自定义详情
work_link 作品链接
work_content 作品内容
1.2.3 服务器响应

示例

  • 成功:
  • {
  • "success" : true,
  • "business_num" : "800000000111223",
  • " hash" :“ sdfasdfasdfasdfasdfasdfasdfadf”,
  • "txid": "sdfasdfasdfasdfqwerwefererfqefqrqghwtoioiejvoie",
  • "regnum":"CRC-201612120005"
  • }
  • 失败:
  • {
  • "success" : false,
  • "message" : "业务流水号格式错误"
  • }
1.2.4 服务器响应说明
参数 说明
success 成功失败标识。      true:成功 | false:失败
business_num 业务系统唯一32位以内流水号
hash 版权信息打包登记在区块链的hash值
txid 登记入区块链的交易id,可在区块链科技金融大数据中心查询版权信息。
regnum 版权登记号
message 表示版权登记失败原因。
当success=true时,返回空值。当success=false时,返回失败的原因。
1.3 版权查询

开发者可通过该接口,使用业务流水号(business_num)进行版权信息查询。

1.3.1 https请求方式:get

接口地址:https://api.taiyiyun.com/copyright/?token=token&api.copyright.search&business_num=business_num

1.3.2 参数说明
参数 说明
token 授权给开发者的token。
business_num 业务系统唯一32位以内流水号。
1.3.3 服务器响应

示例

  • 成功:
  • {
  • “success”:true,
  • “hash”: “sdfasdfasdfasdfasdfasdfasdfadf”,
  • “txid”:”asdfoasfjoqwnelfjqoiwejfoqwiejfoiewf”,
  • “regnum“ : “CRC-201612120003”,
  • “url”:"www.pingguo.com”
  • }
  • 失败:
  • {
  • "success" : false,
  • "message" : "业务流水号错误"
  • }
1.3.4 服务器响应说明
参数 说明
success 成功失败标识。      true:成功 | false:失败
hash 版权信息打包登记在区块链的hash值。
txid 登记入区块链的交易id,可在区块链科技金融大数据中心查询版权信息。
regnum 版权登记号
url 区块链版权证书
message 表示版权登记失败原因。
当success=true时,返回空值。当success=false时,返回失败的原因。
1.4 版权信息变更

开发者可通过该接口进行版权变更,主要应用于著作权人信息更改、作品信息更改,此时需要在区块链注销掉版权原数字指纹,启用版权变更后新的数字指纹;

1.4.1 https请求方式:post

接口地址:https://api.taiyiyun.com/copyright/?token=token&taiyiyun.api=api.copyright.change

post数据格式:json

post请求数据示例

  • {
  • “old_business_num” : “12342432434332cdffdsdffdfdf”,
  • "business_num" : ”77755543534545344dffdf”,
  • “hash” : “sdfasdfasdfasdfasdfasdfasdfadf” ,
  • “work_type” : “美术作品”,
  • "author" : ”张三”,
  • “work_name” : “蔚蓝的天空” ,
  • “copyright_owner” : “张三” ,
  • “finish_time” : “2016年03月05日” ,
  • “first_pubtime” : “2016年04月05日” ,
  • “regist_time” : “2016年05月04日 12:12:12” ,
  • “abstract”:”该作品采用油墨结合风格进行创作”,
  • “custom_detail” : “自定义类型”,
  • “work_link”:www.huaban.com/12345,
  • “work_content”:一只小鸟在蔚蓝的天空翱翔
  • }
1.4.2 参数说明
参数 说明
old_business_num 原业务流水号
business_num 业务系统唯一32以内位流水号
hash 版权原数据64位hash值
work_type 版权类型(从大类到小类组合)
author 作品作者
work_name 作品名称
copyright_owner 著作权人
finish_time 著作完成时间
first_pubtime 首次发表时间
regist_time 登记时间
copy_abstract 版权摘要
custom_detail 版权用户自定义详情
work_link 作品链接
work_content 作品内容
1.4.3 服务器响应

示例

  • 成功:
  • {
  • "success" : true,
  • " hash" :“ sdfasdfasdfasdfasdfasdfasdfadf”,
  • "txid": "sdfasdfasdfasdfqwerwefererfqefqrqghwtoioiejvoie",
  • "regnum":"CRC-201612120005"
  • }
  • 失败:
  • {
  • "success" : false,
  • "message" : "原业务流水号格式错误"
  • }
1.4.4 服务器响应说明
参数 说明
success 成功失败标识。      true:成功 | false:失败
hash 版权信息打包登记在区块链的hash值
txid 登记入区块链的交易id,可在区块链科技金融大数据中心查询版权信息。
regnum 版权登记号
message 表示版权登记失败原因。
当success=true时,返回空值。当success=false时,返回失败的原因。