6DGS云-API文档

G节点简介

G节点是由6DGS云（基于六度共识算法）推出的，基于区块链云链主机的轻节点云服务。
G节点的创建非常方便，这得益于我们易用且强大的区块链底层，创建一个G节点仅需鼠标点点1分钟即可完成！

6DGS云与其它云服务最大的不同是：基于区块链专利技术六度共识算法。

这个算法最大的特点是基于无限分叉链（每一个token帐户，都是一个token节点，也是一个token链），
每一个token链（帐户）都是由TOKEN_ROOT节点分叉出来的子帐户或者子孙帐户的子帐户。
基于这样的帐本数据构建，我们实现了区块链帐本同步的高效率（最快可以达到10-30ms完成六度共识同步）。
并且由于帐本的简单性、可扩展性，我们提供了一整套的易于使用的http-api（数据协议为：json）。
这使得6DGS云成为了最易于使用和理解的区块链云服务。

5个基础合约

为了便于使用，我们初步提供了5种常见的内置智能合约：

COIN-记帐型（适合有数量上限的各类合约币或者权益币；如群老大的社群创世币，上限为1个亿）
SCORE-记帐型（适合没有数量上限的各类积分类型币；其中人民币、美元、社区币都是这种类型）
MSG-消息型（内建的私聊、群聊、系统消息等的基础通信功能）
TEXT-内容型（内建的CMS型、商品和其他的长文本内容型合约）
CLT-合约型（支持如商品订单、身份认证、电子合同、版权等）

【注意】MSG、TEXT、CLT都是相似的6DGS云合约，他们之间可以混用，并无绝对的使用界限（比如CLT也可作为CRM、CMS、ERP、电商商品内容等的系统）

API接口规范

对于提供的http-api（非Restfull规范），6dgs.node（6DGS云G节点）有以下规范：

域名规范：https://{deploy_area_code}.6dgs.opencom.cn/node.{user_name}.{token_name}
API接口：${host}{API_URL} 例如：http://c0.6dgs.opencom.cn/node.jkl.coin/fork（注意：/fork为API_URL）
KEY规范：appid={appid}&secret_key={secret_key}，例如：https://c0.6dgs.opencom.cn/node.jkl.coin/fork?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c
参数规范:当使用url拼接时，如有中文和一些特殊的字符请使用urlencode进行编码，urlencode工具地址
返回值规范:json对象（{ret,msg,list}。其中ret为true或者false；msg成功时为success，失败时提示出错信息；list为数据列表（如查询链信息）
token帐户：token帐户是由TOKEN_ROOT（{token_name}_0000000000000000）fork（分叉出来的），每一个token-id的前缀必定是token_name，token_id是16位的随机字符串（可以定制）。
示例-fork创建一个新token-id：https://c0.6dgs.opencom.cn/node.jkl.coin/fork?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token=coin_0000000000000000

/fork（创建新帐户API）

示例/fork创建一个新token-id：

API-URL：https://c0.6dgs.opencom.cn/node.jkl.coin/fork?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token=coin_0000000000000000
key参数： appid与secret_key（由G节点管理页面获取）
token参数：这里由TOKEN_ROOT分叉出来（token-id是16个0）
dst_token可选参数：创建的目标token-id（格式必须自己确定正确，为：{token_name}_{token_id}，token_id为16位的数字或者英文字符）
space可选参数：创建的目标token-id的前缀（不超过16位的数字或者英文字符），示例：cash、user、order、postid等等；【注意】当dst_token存在时，space参数不发挥作用
示例1-space：https://c0.6dgs.opencom.cn/node.jkl.coin/fork?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token=coin_0000000000000000&space=cash 得到token-id:"token_x":"coin_cash24vXjm68k42R"
示例2-dst_token：https://c0.6dgs.opencom.cn/node.jkl.coin/fork?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token=coin_0000000000000000&dst_token=coin_user24vXjm68k42R
示例2返回结果：{"ret":true,"txid":"txid_2z3VATKLSjVJCk3g","token_x":"coin_user24vXjm68k42R","public_key":"ffhGzL8f3mFqMmBJyWMrC3H6dEK9RoE1XeAPQHuerKaq","private_key":"6exQQTojuHjdmXGVVHvzDitsPB2yEcNJe2qACJg6sHym"}
返回结果解析：ret=true代表fork成功；txid是区块链交易纪录id，全局唯一；token_x为创建成功的token-id；public_key为公钥，private_key为私钥（暂时不提供基于私钥的交易/send指令接口）

/send（发送内容或者转帐API）

示例/send（转帐或者发送内容）：

API-URL：https://c0.6dgs.opencom.cn/node.jkl.coin/send?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token_x=coin_0000000000000000&token_y=coin_user24vXjm68k42R&opval=100&extra_data=send-val-test
key参数： appid与secret_key（由G节点管理页面获取）
token_x参数：这里是TOKEN_ROOT分叉出来（token-id是16个0），对于有上限的COIN合约，只要TOKEN_ROOT还没转出coin_top_val（币上限数量）的值，就可以由TOKEN_ROOT继续转出；SCORE-记帐型是没有上限的记帐合约，适合人民币和积分等的充值-支付等的记帐型业务
token_y参数：接收转帐或者短消息/文本内容/合约内容的token-id
opval参数：转帐数额（COIN与SCORE型，只能为数字，精度为COIN为小数点后8位，SCORE为小数点后4位；如果是非记帐型，opval是一段文本--POST方法下的上限值）
extra_data参数：额外参数（会存放在链上），用于做订单识别等（例如extra_data=order_id或者extra_data=order_name，或者extra_data=JSON.stringify(orderInfo)等
示例1-COIN：https://c0.6dgs.opencom.cn/node.jkl.coin/send?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token_x=coin_0000000000000000&token_y=coin_user24vXjm68k42R&opval=100&extra_data=send-val-test
示例2-SCORE：https://c0.6dgs.opencom.cn/node.jkl.score/send?appid=10001&secret_key=f97caf838328a4e730c7eabacfdcb281&token_x=score_0000000000000000&token_y=score_27EU7XmQ5LRLeMc7&opval=100&extra_data=order_1234567890123456
示例3-MSG：https://c0.6dgs.opencom.cn/node.jkl.msg/send?appid=10001&secret_key=4fa5ebb53ee316935c50facd445c7e98&token_x=msg_0000000000000000&token_y=msg_31CxArxGa8Q37isx&opval=hellouser&extra_data=user_1234567890123456
返回结果解析：ret=true代表send成功；txid是区块链交易纪录id，全局唯一；list为六度共识同步的节点清单信息（对于COIN-记帐型和SCORE-记帐型，会有token_state代表最终的余额）---不常用，仅用于测试用途（后续可能会停止同步list字段），对于查询token-id的链情况，建议使用chain查询API

/op（链指令API）

示例/op（链指令API）：

API-URL：https://c0.6dgs.opencom.cn/node.jkl.coin/op?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token_x=coin_0000000000000000&token_y=coin_user24vXjm68k42R&opval=100&extra_data=send-val-test&opcode=send
key参数： appid与secret_key（由G节点管理页面获取）
token_x参数：这里是TOKEN_ROOT分叉出来（token-id是16个0），对于有上限的COIN合约，只要TOKEN_ROOT还没转出coin_top_val（币上限数量）的值，就可以由TOKEN_ROOT继续转出；SCORE-记帐型是没有上限的记帐合约，适合人民币和积分等的充值-支付等的记帐型业务
token_y参数：接收转帐或者短消息/文本内容/合约内容的token-id
opcode参数：send（转帐或发送，同/send）；fork（分叉-新建帐户，同/fork）；assert（声明，将声明内容保存链上）；config（配置，将config内容保存链上）；notice（公告，将notice内容保存在链上）；其它：chkey,setkey,phone,relate,join,hold,fsm作为暂时保留使用的指令，未来会扩充这些指令的功能（现在也可以使用，其中：hold,join,relate会形成relations关系，在opcode=hold,join,relate时，opval=add、del可以添加或者删除映射关系，extra_data可以附带参数信息；通过/chain/relations可以查询1对多或者多对多映射关系；）注意：（2019-8-6新增rela、relb、relc...relz共新增26个与relate命令效果一样的映射关系命令字；2019-8-15新增sms云短信指令，2019-8-16新增mail云邮件指令和pay云支付指令，2019-9-5新增wslisten即时链指令）
opval参数：转帐数额（COIN与SCORE型，只能为数字，精度为COIN为小数点后8位，SCORE为小数点后4位；如果是非记帐型，opval是一段文本--POST方法下的上限值）
extra_data参数：额外参数（会存放在链上），用于做订单识别等（例如extra_data=order_id或者extra_data=order_name，或者extra_data=JSON.stringify(orderInfo)等
示例1-assert：https://c0.6dgs.opencom.cn/node.jkl.coin/op?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token_x=coin_0000000000000000&token_y=coin_user24vXjm68k42R&opval=assertinfo&extra_data=send-assert-val-test&opcode=assert
示例2-config：https://c0.6dgs.opencom.cn/node.jkl.coin/op?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token_x=coin_0000000000000000&token_y=coin_user24vXjm68k42R&opval=config-info&extra_data=send-config-val-test&opcode=config
示例3-notice：https://c0.6dgs.opencom.cn/node.jkl.coin/op?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token_x=coin_0000000000000000&token_y=coin_user24vXjm68k42R&opval=notice-info&extra_data=send-notice-val-test&opcode=notice
示例4-hold（opval=add）：https://c0.6dgs.opencom.cn/node.jkl.obj/op?appid=10001&secret_key=be7e65b431e98cc10413b90b0c55b717&token_x=obj_fapiaolist2xrsDL&token_y=obj_fapiao21SVe7Ddrs&opval=add&extra_data=add2fapiaolist&opcode=hold
示例5-hold（opval=del）：https://c0.6dgs.opencom.cn/node.jkl.obj/op?appid=10001&secret_key=be7e65b431e98cc10413b90b0c55b717&token_x=obj_fapiaolist2xrsDL&token_y=obj_fapiao21SVe7Ddrs&opval=del&extra_data=add2fapiaolist&opcode=hold
返回结果解析：ret=true代表op指令执行成功；txid是区块链交易纪录id，全局唯一；list为六度共识同步的节点清单信息（对于COIN-记帐型和SCORE-记帐型，会有token_state代表最终的余额）---不常用，仅用于测试用途（后续可能会停止同步list字段），对于查询token-id的链情况，建议使用chain查询API

/chain（链查询API）

示例/chain/opcode（token子链查询指令API）：

API-URL：https://c0.6dgs.opencom.cn/node.jkl.coin/chain/opcode?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token=coin_user24vXjm68k42R&begin=0&len=10&opcode=send
key参数： appid与secret_key（由G节点管理页面获取）
token参数：查询的token-id
opcode参数：send（转帐或发送，同/send）；fork（分叉-新建帐户，同/fork）；assert（声明，将声明内容保存链上）；config（配置，将config内容保存链上）；notice（公告，将notice内容保存在链上）；其它：chkey,setkey,phone,relate,join,hold,fsm作为暂时保留使用的指令，未来会扩充这些指令的功能（现在也可以使用，但不推荐使用）
begin参数：从0到token-height（任意整数，代表分页开始位置）
len参数：page_len（非0整数，推荐10或者20等）
示例1-assert：https://c0.6dgs.opencom.cn/node.jkl.coin/chain/opcode?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token=coin_user24vXjm68k42R&begin=0&len=10&opcode=assert
示例2-config：https://c0.6dgs.opencom.cn/node.jkl.coin/chain/opcode?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token=coin_user24vXjm68k42R&begin=0&len=10&opcode=config
示例3-notice：https://c0.6dgs.opencom.cn/node.jkl.coin/chain/opcode?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token=coin_user24vXjm68k42R&begin=0&len=10&opcode=notice
示例4-fork：https://c0.6dgs.opencom.cn/node.jkl.coin/chain/opcode?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token=coin_0000000000000000&begin=0&len=10&opcode=fork
示例5-send：https://c0.6dgs.opencom.cn/node.jkl.coin/chain/opcode?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&token=coin_user24vXjm68k42R&begin=0&len=10&opcode=send
返回结果解析：ret=true代表查询成功（有list数据返回）；txid是区块链交易纪录id，全局唯一；list为链上关于opcode指令的交易或发送内容纪录（对于COIN-记帐型和SCORE-记帐型，会有txjson.token_state代表最终的余额；其中txjson为文本，需要使用JSON.parse转回JSON对象；txjson.opval为操作的值；txjson.timestamp_i为交易纪录创建并保存的unix时间戳）

示例/chain/query（整条链链查询指令API）：

API-URL：https://c0.6dgs.opencom.cn/node.jkl.coin/chain/query?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&begin=0&len=10
key参数： appid与secret_key（由G节点管理页面获取）
begin参数：从0到token-height（任意整数，代表分页开始位置）
len参数：page_len（非0整数，推荐10或者20等）
示例1-COIN：https://c0.6dgs.opencom.cn/node.jkl.coin/chain/query?appid=10001&secret_key=bf9391d9c37b7c6e1e4666746263580c&begin=0&len=10
示例2-SCORE：https://c0.6dgs.opencom.cn/node.jkl.score/chain/query?appid=10001&secret_key=f97caf838328a4e730c7eabacfdcb281&begin=0&len=10
示例3-MSG：https://c0.6dgs.opencom.cn/node.jkl.msg/chain/query?appid=10001&secret_key=4fa5ebb53ee316935c50facd445c7e98&begin=0&len=10
返回结果解析：ret=true代表查询成功（有list数据返回）；txid是区块链交易纪录id，全局唯一；list为链上关于opcode指令的交易或发送内容纪录（对于COIN-记帐型和SCORE-记帐型，会有txjson.token_state代表最终的余额；其中txjson为文本，需要使用JSON.parse转回JSON对象；txjson.opval为操作的值；txjson.timestamp_i为交易纪录创建并保存的unix时间戳）

示例/chain/relations（hold,join,relate以及rela-relz关系列表查询）：

API-URL：https://c0.6dgs.opencom.cn/node.jkl.obj/chain/relations?appid=10001&secret_key=be7e65b431e98cc10413b90b0c55b717&token=obj_fapiaolist2xrsDL&opcode=hold&isx=true&begin=0&len=10
key参数： appid与secret_key（由G节点管理页面获取）
token参数：查询的token-id
opcode参数：只能是hold,join,relate（2019-8-6新增rela、relb、relc...relz共新增26个与relate命令效果一样的映射关系命令字）
isx参数：当为true时，代表relations查询的是token_x，否则查询的是token_y
begin参数：从0到token-height（任意整数，代表分页开始位置）
len参数：page_len（非0整数，推荐10或者20等）
示例1-obj：https://c0.6dgs.opencom.cn/node.jkl.obj/chain/relations?appid=10001&secret_key=be7e65b431e98cc10413b90b0c55b717&token=obj_fapiaolist2xrsDL&opcode=hold&isx=true&begin=0&len=10
返回结果解析：ret=true代表查询成功（有list数据返回）；txid是区块链交易纪录id，全局唯一；list是relations映射纪录列表（token_x,token_y,opcode,txid,create_time_i,create_time）
结果示例如下：
{"ret":true,"msg":"success","list":[{"token_x":"obj_fapiaolist2xrsDL","token_y":"obj_fapiao28Aazyt5A7","opcode":"hold","txid":"txid_32MxKjjdP5GTUpZF","create_time_i":1560767066,"create_time":"2019-06-17T10:24:26.000Z"},{"token_x":"obj_fapiaolist2xrsDL","token_y":"obj_fapiao32apStXwrq","opcode":"hold","txid":"txid_21SiJo2cKifm7S4v","create_time_i":1560767058,"create_time":"2019-06-17T10:24:18.000Z"},{"token_x":"obj_fapiaolist2xrsDL","token_y":"obj_fapiao23XsdWQSSe","opcode":"hold","txid":"txid_22PsvqdU3HF3AZbH","create_time_i":1560767048,"create_time":"2019-06-17T10:24:08.000Z"},{"token_x":"obj_fapiaolist2xrsDL","token_y":"obj_fapiao31BxCGyd9V","opcode":"hold","txid":"txid_xv7Qz2Fys8BnQ1LN","create_time_i":1560767036,"create_time":"2019-06-17T10:23:56.000Z"},{"token_x":"obj_fapiaolist2xrsDL","token_y":"obj_fapiao21SVe7Ddrs","opcode":"hold","txid":"txid_z43nLLocjUKtGQFD","create_time_i":1560766950,"create_time":"2019-06-17T10:22:30.000Z"}]}
可以使用 /op指令示例5-hold（opval=del）删除关系：https://c0.6dgs.opencom.cn/node.jkl.obj/op?appid=10001&secret_key=be7e65b431e98cc10413b90b0c55b717&token_x=obj_fapiaolist2xrsDL&token_y=obj_fapiao21SVe7Ddrs&opval=del&extra_data=add2fapiaolist&opcode=hold
可以使用 /op指令示例4-hold（opval=add）：https://c0.6dgs.opencom.cn/node.jkl.obj/op?appid=10001&secret_key=be7e65b431e98cc10413b90b0c55b717&token_x=obj_fapiaolist2xrsDL&token_y=obj_fapiao21SVe7Ddrs&opval=add&extra_data=add2fapiaolist&opcode=hold

示例/chain/relations/exists（hold,join,relate以及rela-relz的关系是否存在查询-返回true或者false）：

API-URL：https://c0.6dgs.opencom.cn/node.jkl.obj/chain/relations/exists?appid=10001&secret_key=be7e65b431e98cc10413b90b0c55b717&token_x=obj_fapiaolist2xrsDL&token_y=obj_fapiao28Aazyt5A7&opcode=hold
key参数： appid与secret_key（由G节点管理页面获取）
token_x参数：主列token-id
token_y参数：次列token-id
opcode参数：只能是hold,join,relate（2019-8-6新增rela、relb、relc...relz共新增26个与relate命令效果一样的映射关系命令字）
示例1-obj：https://c0.6dgs.opencom.cn/node.jkl.obj/chain/relations?appid=10001&secret_key=be7e65b431e98cc10413b90b0c55b717&token=obj_fapiaolist2xrsDL&opcode=hold&isx=true&begin=0&len=10
返回结果解析：ret=true代表存在token_x与token_y的映射表关系。ret=false代表不存在。其它字段：txid代表影响该映射关系存在与否的最后一条纪录。
结果示例如下：
{"token_x":"obj_fapiaolist2xrsDL","token_y":"obj_fapiao28Aazyt5A7","opcode":"hold","txid":"txid_32MxKjjdP5GTUpZF","create_time_i":1560767066,"create_time":"2019-06-17T10:24:26.000Z","ret":true,"msg":"success"}

6DGS云