Get Started On Platform

我们为开发者准备了测试环境和正式环境两套接口地址，测试环境可以在不需要SecretKey和AccessToken的情况下使用，但调用返回均是无效的测试数据。

• 注册付费或免费的CoinSU账户。
• 登录用户面板并创建SecretKey和AccessToken。
• 在用户面板设置消息通知回调接口。
• 参照本文档对API的定义描述完成API调用和开发。
• 使用文档中心提供的测试工具完成接口调试。

Environment

我们为开发者准备了测试环境和正式环境两套接口地址，测试环境可以在不需要SecretKey和AccessToken的情况下使用，但调用返回均是无效的测试数据。

API Regulation

API调用格式如下（中括号内为注解），每次调用接口，确保接口URL符合如下格式。同时我们只允许通过POST请求的方式调用API。其他请求将被拒绝。

https://api.zkweb3.xyz/_api/[版本号]/[模块名]/[方法名]

Authentication

在调用接口前，您需要在HTTP请求头部设置好SecretKey和AccessToken确保API能正确识别您的身份，然后设置参数和模块名和方法名来调用接口，例如适用Python来调用接口的完整代码如下。同时您也应该确保将SecretKey和AccessToken保存在安全的位置避免泄露造成安全事故。

nodejs 敬请期待

php 敬请期待

java 敬请期待

Data Format

所有API均使用Json作为数据交换格式，创建ETH钱包地址的请求和响应例子如下。

请求 ：

{

	"uid": "u6b286c90-0728-11e9-ab94-7d71263ebce",
	"coin_type": "ETH"

}

返回 ：

{
	"retcode": "200",
	"retmsg": "OK",
	"data": {
	"address": "0xC98cd7ffff974bDeC2FB00DA6d5597B5D4917bb4"
	}
}
			

Error Code

接口调用如果成功，则返回HTTP 200 OK，如果失败则返回对应的HTTP状态码，以及在返回的参数retcode中返回错误码，以及retmsg错误代码参考。

Cryptocurrency Support

CoinSU提供了丰富的币种支持，包括公链币种和基于公链的代币协议。币种支持大约每个月更新一次，如果您对于新币种支持有任何建议，或者您的某个数字资产创办者，可以通过邮件support@zkweb3.xyz联系我们获得支持。以下为CoinSU支持的加密货币币种列表。

以下为CoinSU支持的基于以太坊ERC20协议的的扩展币种列表。

Required Confirm Number

CoinSU为避免支持的币种出现双花算力攻击而导致交易回滚，根据不同公链的出块速度，算力大小，为保障安全约定了交易确认次数（即包含交易的块后续追加块数），才达到约定确认次数后，交易方可被认可并计入余额。约定交易确认次数如下。

Callback Format

在您创建SecretKey和AccessToken的同时，同时也需要设置对应的回调接口，以下是回调返回格式,notify_code返回为1时为交易结果的回调，返回2时为审批结果的回调

{
	"notify_code":"1",
	"sign":"",
	"msgid":"tx10021",
	"data":{
		//返回参数见Callback,返回json字符串
	}
}
			

API v1

Callback

Transaction Notify

Description：

在您创建SecretKey和AccessToken的同时，同时也需要设置对应的回调接口，以方便我们在完成支付或钱包余额变更等情况下，向应用提供消息通知服务，并请您确保您设置的消息通知回调接口高可用，在服务器通过HTTP请求您的回调接口失败的情况下，服务器会间隔一定时间后重新发起请求，直到返回成功。(在交易0次确认，1次确认和交易成功的时候会回调该接口,如回调成功，请在返回数据中，返回json格式的{"ret":"1"}用于通知我们,回调地址在管理中心设置),notify_code为1时返回如下

Request parameter description：

Auditing Notify

Description：

审批回调结果（notify_code为2时）返回参数如下：

Request parameter description：

Parameter Type

User Authority

变量名：authority_code : 该参数用于描述创建用户的角色id

Currency Support

变量名：coin_type : 该参数用于描述币种类型,支持如下币种

Currency flow

变量名：funds_status : 该参数用于描述资金状态

Transaction status

变量名：status : 该参数用于描述交易的状态

Increase in service charges

变量名：fast : 该参数用于描述是否增加矿工费实现快速提现

Example

Create Sub User And ETH Wallet

创建一个子账户，并且为该子账户创建ETH钱包地址

import requests
import json

apiurl = 'https://api.zkweb3.xyz/_api/v1/'

headers = {
	'Secret-Key': 'dAzX1CcfBnPpQd6riw649hasPgk0OvCMvayxA6rfUwAfdBiBIRX/7g==',
	'Access-Token': 'ZszDJ9cAEUjdU0fGIrw9zeZf9LQOhTZz3oqalXv546sfjdzsaXqqOKf1X6YQaYMlyPOMCNdQjwyZVmhS0jQrAvrbg=='
}

data = {
	'authority_code': 0,
	'email': 'tom@gmail.com',
	'name': 'tom'
}
data = json.dumps( data )

rep = requests.post(apiurl + 'account/CreateAccount',data = data, headers = headers)

ret = json.loads(rep.content)
uid = ret['uid']

data = {
	'uid': uid,
	'coin_type': 'ETH'
}
data = json.dumps( data )

rep = requests.post(apiurl + 'account/CreateWallet',data = data, headers = headers)

print(json.loads(rep.content)['address'])