7. API列表 - 7.1 测试环境API - 《迅雷链智能合约开发指南》

7.1 测试环境API

7.1 测试环境API

7.1.1 获取邮箱验证码

功能

获取邮箱验证码用于测试用户注册。

请求

方法：POSTURL: /api/linktest/email_codeBODY: JSON

参数说明：

参数名	参数类型	必须	说明
email	string	是	测试使用的email

响应

参数名	参数类型	必须	说明
code	int	是	错误码，0：成功非0：失败
msg	string	是	错误提示信息
data	object	否	请求返回数据

7.1.2 使用邮箱注册

功能

测试注册接口，使用email地址。用户第一次注册，产生service_id/secret通过邮件形式发送给开发者。如果邮箱地址已经注册，返回错误码。

请求

方法：POSTURL: /api/linktest/registBODY: JSON

参数说明：

参数名	参数类型	必须	说明
email	string	是	测试使用的email，主要用于接收测试消息
emailcode	string	是	注册前使用的邮件验证码

响应

参数名	参数类型	必须	说明
code	int	是	错误码，0：成功非0：失败
msg	string	是	错误提示信息
data	object	否	请求返回数据

7.1.3 测试账号充值

功能

申请将测试燃料充值到指定的账户，开发者给自有的账户充值后用于测试活动。每申请一次转入10个测试燃料。每个email每天最多调用10次。也可以通过Catalyst工具直接领取测试燃料。

请求

方法：POSTURL: /api/linktest/rechargeBODY: JSON

参数说明：

参数名	参数类型	必须	说明
email	string	是	测试使用的email，主要用于接收测试消息
address	string	是	需要充值的账号地址
sign	string	是	签名md5(email=xxx&address=xxx&secret=xxx), xxx填写请求的实际值

响应

参数名	参数类型	必须	说明
code	int	是	错误码，0：成功非0：失败
msg	string	是	错误提示信息
data	object	否	请求返回数据

7.1.4 合约发布

功能

用户发布合约到测试环境，用户提供编译后的字节码。

请求

方法：POSTURL: /api/linktest/contract/deployBODY: JSON

参数说明：

参数名	参数类型	必须	说明
email	string	是	测试使用的email，主要用于接收测试消息
bytecode	string	是	编译后的合约字节码，十六进制ABI格式
params	string	否	构造函数初始化参数，十六进制ABI格式
sign	string	是	签名md5(email=xxx&bytecode=xxx&params=xxx&secret=xxx), xxx填写请求的实际值。即使params为空也需要计算到sign里

响应

参数名	参数类型	必须	说明
code	int	是	错误码，0：成功非0：失败
msg	string	是	错误提示信息
data	object	否	请求返回数据

data

参数名	参数类型	必须	说明
id	int	是	合约部署产生的id,通过这个id可查询合约部署后的地址

7.1.5 合约地址查询

功能

通过合约部署产生的id查询合约账户地址。

请求

方法：POSTURL: /api/linktest/contract/addressBODY: JSON

参数说明：

参数名	参数类型	必须	说明
email	string	是	测试使用的email，主要用于接收测试消息
id	int	是	合约部署返回的id
sign	string	是	签名md5(email=xxx&id=xxx&secret=xxx), xxx填写请求的实际值

响应

参数名	参数类型	必须	说明
code	int	是	错误码，0：成功非0：失败
msg	string	是	错误提示信息
data	object	否	请求返回数据

data

参数名	参数类型	必须	说明
address	string	是	账户地址

7.1.6 查询最近部署的合约地址

功能

查询最近部署的合约id和合约地址。

请求

方法：POSTURL: /api/linktest/contract/lastBODY: JSON

参数说明：

参数名	参数类型	必须	说明
email	string	是	测试使用的email，主要用于接收测试消息
sign	string	是	签名md5(email=xxx&secret=xxx), xxx填写请求的实际值

响应

参数名	参数类型	必须	说明
code	int	是	错误码，0：成功非0：失败
msg	string	是	错误提示信息
data	object	否	请求返回数据

data

参数名	参数类型	必须	说明
id	int	是	合约ID
address	string	是	账户地址

7.1.7 生成扫码支付的URL信息

功能

开发者提交交易信息，获取到一个交易URL用于扫码支持。支持合约支付和第三方支付。此接口是为了方便开发者测试，已封装了请求prepay_id的流程，仅适用于测试环境。正式环境不提供此接口，需要开发者后台实现prepayid接口和url请求。

请求

方法：POSTURL: /api/linktest/tx_generateBODY: JSON

请求参数

参数名	参数类型	必须	说明
email	string	是	测试注册的email
to	string	是	合约地址或者账户地址
value	string	是	转入的token数量,十进制整数，单位wei
callback	string	是	回调URL
title	string	是	交易信息标题，例如：“合约调用-存证信息上链”
desc	string	是	交易详细信息，例如：“兑换xxx服务”
gas_limit	string	否	执行合约最多消耗GAS值，十进制整数，合约交易才填
data	string	否	执行的合约代码，十六进制字符串，以0x开头。包含函数地址和调用参数。只发起转账，这个内容为空。合约交易才填
tx_type	string	是	交易类型，合约交易：contract，第三方交易：tx_third
sign	string	是	请求签名，用于校验请求真实性 md5(email=xxx&to=xxx&value=xxx&secret=xxx)

响应

BODY: JSON

响应参数

参数名	参数类型	必须	说明
code	int	是	错误码，0：成功非0：失败
msg	string	是	错误提示信息
data	object	否	请求返回数据

data

参数名	参数类型	必须	说明
url	string	是	生成的URL，用于扫码获取交易信息
expire	int	是	URL过期时间，单位毫秒

7.1.8 扫码获取交易信息

功能

获取订单详细信息，请求URL由接口（/api/linktest/tx_generate）生成。开发者通过迅雷链助手APP扫码获取订单URL，迅雷链助手APP请求此URL获取交易信息，签发交易

请求

方法：GETURL: /api/linktest/tx_info/:tx_idBODY: null

参数说明：

参数名	参数类型	必须	说明
tx_id	string	是	携带在path中的参数，动态交易ID，十六进制字符串

响应

参数名	参数类型	必须	说明
content	stream	是	迅雷链助手APP支付协议格式的交易信息