APIP速查
-
APIP速查
示例数据
requester: FEk41Kqjar45fLDriztUDTUkdki7mmcjWK requester的公钥: 030be1d7e633feb2338a74a860e76d893bac525f35a5813cb7b21e27ba1bc8312a requester的私钥: L2bHRej6Fxxipvb4TiR5bu1rkT3tRp8yWEsUy4R1Zb8VMm2x7sd8 requester的symKey: d2c03bbc1ba1380eafc395374e8da61f92545a1aac5d30b0c19289a69bd34a09 API URL: https://www.sign.cash/api/
流程
详见APIP1V1_OpenAPI(zh-CN)
-
发布URL: API服务商在链上按照《FEIP29_Service》协议,将API服务的URL在发布上链。
-
建立连接:请求方通过
connect
接口提交私钥签名,请求连接API服务,成功后获得对称密钥symKey
用于数据请求和验证。示例:
GET方法请求连接: https://www.sign.cash/api/connect?pubkey=030be1d7e633feb2338a74a860e76d893bac525f35a5813cb7b21e27ba1bc8312a×tamp=1635513688254&sign=H5viYRRPi4fr4ivgWAiSkWS7pLRpo%2B8YjiJ2FaRjnCDqUSUlEgIfav%2FAsYXYe862EgGUjICSISr8QeL1qIXCRfI%5Cu003d POST方法请求连接: {"publicKey":"030be1d7e633feb2338a74a860e76d893bac525f35a5813cb7b21e27ba1bc8312a","timestamp":1635513688254,"url":"https://www.sign.cash/api/connect","sign":"IPZEm2XcRA2dxw3OFrHLT5KzS03MqZyp++QT/3TF5AGdfcfm0GCZo8t8FUE+MLiZ7ZNH0GV1Er8pJole+Qv73lE\u003d"} 响应参数: { "ciphertext"="Ay99PxkGYfvfudU8h3fpD/Ez2laBaGkNKdDH1bJ7PWemOTnC7YIOVmYelqhQp0PYV9mvm3DIOsXv8U7PT7wtU2+gUAUPeimdZP94rKXr3p4kS2hszh0dYaTrsMOGLc+WDyCq9GdhHOfsWlEFH9fBnoNeDJsOnBXSphRfXWdZpkgTzD3nTiQcqTZDPrF5WO6Id6CiiuFVjXaAZtgzAUHmaTI=", "days":365 } ciphertext的原文为: {"symKey":"d2c03bbc1ba1380eafc395374e8da61f92545a1aac5d30b0c19289a69bd34a09"}
-
准备参数:请求数据时,在请求参数中加入
timestamp
,采用POST方法时,还需加入API的url
。 -
参数排序:所有请求参数按字母升序排列,不区分大小写。
-
数据签名:将
symKey
追加至参数末尾,然后经两次sha256哈希获得签名sign
。 -
发送请求:删除
symKey
字段,将requester
和sign
追加至末尾,发送给服务方。示例:
GET https://www.sign.cash/api/balance?address=FTqiqAyXHnK7uDTXzMap3acvqADK4ZGzts×tamp=1635513688254&requester=FEk41Kqjar45fLDriztUDTUkdki7mmcjWK&sign=1111111111111110000000000000000000000 POST {"address":"FTqiqAyXHnK7uDTXzMap3acvqADK4ZGzts","timestamp":1635513688254,"url":"https://www.sign.cash/api/balance","requester":"FEk41Kqjar45fLDriztUDTUkdki7mmcjWK","sign":"1111111111111111111111112222222222222222222222223333333333"}
-
验证请求:API服务方验证
requester
授权、sign
、timestamp
、POST方法url
等均有效或正确后予以响应。 -
响应数据:响应数据尾部加入
symKey
后做两次sha256哈希获得sign
,再用sign
替换symKey
后将数据返回请求方。示例:
{"cdBalance":2100000000,"cdd":"342742273400","changeUnconfirmed":-110000000,"fchBalance":210000000,"heignt":963667,"utxoNumber":18,"sign":"444441111111111111112222222222222222222222223333333333"}
- 验证数据:请求方获得数据后,用
symKey
替换sign后哈希签名,值与sign值一致则接受数据。
通用约定
详见APIP1V1_OpenAPI(zh-CN)
1. 接口标识
按照APIP类型发布的接口的唯一标识为:
接口名称@PID#[接口协议的PID]
。示例:txList@PID#855fa18ea748a558404dba9fffde10691feac325a6e8fbdc7fc3a0afe84e736d
2. 接口url
API的URL路径由服务商按照
《FEIP29_Service》
协议在“url”字段发布上链。3. 时间戳格式
APIP协议涉及的时间戳,若无特定说明,默认为13位,精确到毫秒。
4. 哈希算法
无特殊说明,哈希算法采用两次sha256算法,即:
sha256(sha256([message]))
.5. 筛选参数
-
筛选参数在原字段名前加filter,如:以cd为筛选条件的字段名为
filterCd
。 -
数字类型:
"filterCd": "-2, 3, 4-5, 7-"
对cd字段进行筛选,选择值小于2(不含2)、或等于3、或4与5之间(含4和5)、或大于4(不含4)的所有条目。
-
字符串类型:
-
模糊查询:
"filterCid": "arm"
不区分大小写,查询cid字段所有包含“arm”的条目,如“C_ARmX”。
-
非空查询:
"filterOpReturn":"notNull"
查询opReturn字段非空的所有条目。
-
为空查询:
"filterOpReturn":"null"
查询opReturn字段为空的所有条目。
-
-
布尔类型:
"filterStatus": 0
查询status字段值为0的所有条目。
-
枚举类型:
"filterMemberStatus": "active, exited"
查询memberStatus值为"active"或"exited"的所有条目。
-
多个筛选字段时,筛选关系为“与”,即满足所有筛选条件。
{ "filterCd": "7-", "filterCid": "arm" } //查询cd大于7,且cid包含"arm"的条目。
6. 排序参数
详见APIP1V1_OpenAPI(zh-CN)
-
排序参数在原字段名前加
sort
,如以cd排序的字段名为sortCd
。 -
排序参数的值为
up
(升序)或down
(降序):"sortCd": "up"
即:以cd字段升序排序
-
每次请求的排序字段唯一,不支持多级排序。
7. 批量请求
详见APIP1V1_OpenAPI(zh-CN)
请求批量数据时:
- 以
count
字段给出每次请求的条目数,由API服务商自定义缺省值。 - 以
sequence
字段给出当前请求第几批次。sequence
从0开始,缺省默认为第0批。
如,请求排序为第201至300项,共100项数据:
{ "count":100, "sequence":2 }
通用返回值
各接口有特定的返回值,共同的返回值为"成功"和"未知错误":
code msg data 0 OK 1 Other error. signedRequest, customErrorMessage 示例:
{ "code":1, "msg":"Unknown error.", "data":{ "signedRequest": "https://www.sign.cash/api/balance?address=FTqiqAyXHnK7uDTXzMap3acvqADK4ZGzts×tamp=1635513688254&requester=FEk41Kqjar45fLDriztUDTUkdki7mmcjWK&sign=1111111111111110000000000000000000000" } }
APIP2V1_BasicInfoOnChain(zh-CN)
本协议接口提供Freecash主链上的主要信息,涉及以下协议:
- coindays:《FIPA4_Coindays》
- guide:《FIPA6_Guide》
1. balance (余额接口)
获取FCH地址的FCH余额、币天余额、累计销毁币天总额。
- 请求参数
{ "address": [string,要查询余额的FCH地址,必填] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "fchBalance": [int64, fch余额,单位为satoshi], "changeUnconfirmed":[int64, 未确认的余额变化,单位为satoshi], "utxoNumber": [int, 该地址的utxo数量], "cdBalance": [int64, 该地址的币天余额], "cdd": [int64,该地址累计销毁的币天], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2000 The address has not been used. address
2. utxoWithMinCd(最小币天utxo接口)
获取满足支付金额,且销毁最小币天所需的utxo列表。
- 请求参数
{ "address": [string,FCH地址,必填], "amount": [int64,金额, 单位为satoshi,必填] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "utxoList": [{ "txid": [string,交易id], "index": [int,索引], "amount": [int64,金额, 单位为satoshi], "cd": [int64,币天] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2000 The address has not been used. address 2001 There is no UTXO at this address. address 2002 There is not enough balance. address,amount 2003 There are too many UTXOs required to pay this amount. Please merge UTXOs first. address,amount,maxUtxoCount
3. utxoFilteredByCd (币天筛选utxo接口)
按照币天进行排序和筛选所需要的特定数量utxo。
- 请求参数
{ "address": [string,要查询余额的FCH地址,必填], "filterCd": [string, cd筛选,参见“通用约定·筛选参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "utxoList": [ //utxo的结构数组 {"txid": [string,交易id], "index": [int,索引], "amount": [int64,金额, 单位为satoshi], "cd": [int64,币天] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2000 The address has not been used. address 2001 There is no UTXO at this address. address 2004 There is no UTXO that meets the conditions. address, filterCd 2005 Too many utxos are requested. utxoCount, maxUtxoCount
4. txInfo (交易信息接口)
获得某笔交易的详细信息。
- 请求参数
{ "txid": [string,交易id],必填" }
- 响应参数
{ "txTimestamp": [timestamp,交易的时间戳], "fee": [int,矿工费,单位satoshi], "cdd": [int,本交易销毁币天], "opReturn": [string, OP_RETURN的内容], "amout": [int64,总金额,单位satoshi], "block": [int, 交易所在区块], "input": [{ "index":[int,索引], "address": [string,FCH地址]], "amount":[int64,金额, 单位为satoshi] } ], "output": [{ "index":[int,索引], "address": [string,FCH地址]], "amount":[int64,金额, 单位为satoshi] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2006 No such TXID. txid
5. txList (交易列表接口)
按条件获取某个地址的历史交易信息列表。
- 请求参数
{ "address": [string,FCH地址,必填], "filterOpReturn": [string, 模糊匹配OP_RETURN内容], "filterCdd": [string, 按销毁币天筛选,参见“通用约定·筛选参数”], "filterChangeUnconfirmed": [string, 按未确认余额筛选,参见“通用约定·筛选参数”], "sortTxTimestamp": [string, 按时间戳排序,参见“通用约定·排序参数”], "sortAmount": [string, 按金额排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "txList": [{ "txTimestamp": [timestamp,交易的时间戳], "fee": [int,矿工费,单位satoshi], "cdd": [int,本交易销毁币天], "opReturn": [string, OP_RETURN的内容], "amout": [int64,总金额,单位satoshi], "block": [int, 交易所在区块], "input": [{ "index":[int,索引], "address": [string,FCH地址]], "amount":[int64,金额, 单位为satoshi] } ], "output": [{ "index":[int,索引], "address": [string,FCH地址]], "amount":[int64,金额, 单位为satoshi] } ] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2000 The address has not been used. address 2001 There is no UTXO at this address. address 2007 No more transactions. address,count,sequence
6. txUnconfirmed (未确认交易接口)
获取某个地址的未确认交易列表。
- 请求参数
{ "address": [string,FCH地址,必填] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "unconfirmedTxList":[{ "txTimestamp": [timestamp,交易的时间戳], "fee": [int,矿工费,单位satoshi], "opReturn": [string, OP_RETURN的内容], "amout": [int64,总金额,单位satoshi], "input": [{ "index":[int,索引], "address": [string,FCH地址]], "amount":[int64,金额, 单位为satoshi] } ], "output": [{ "index":[int,索引], "address": [string,FCH地址]], "amount":[int64,金额, 单位为satoshi] } ] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
code msg data 2000 The address has not been used. address 2008 The address has no unconfirmed transaction. address
7. guide (向导接口)
获取某个地址第一笔fch来源交易的第一个输入地址,作为将该地址引入应用的向导。
- 请求参数
{ "address": [string,FCH地址] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "guide":[string,第一个发送fch给address的FCH地址], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2000 The address has not been used. address
8. opReturnSearch (OpReturn搜索接口)
模糊搜索通过OpReturn保存在链上的内容。
- 请求参数
{ "searchContent": [string, 所要搜索的内容],必填", "filterSigner": [string, 按第一个输入地址筛选], "filterRecipient": [string, 按第一个输出地址筛选], "filterCdd": [string, 按销毁币天筛选,参见“通用约定·筛选参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "sortCdd": [string, 按销毁币天排序,参见“通用约定·排序参数”], "sortAmount": [string, 按交易金额排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "txList": [{ "txTimestamp": [timestamp,交易的时间戳], "fee": [int,矿工费,单位satoshi], "cdd": [int,本交易销毁币天], "opReturn": [string, OP_RETURN的内容], "amout": [int64,总金额,单位satoshi], "block": [int, 交易所在区块], "input": [{ "index":[int,索引], "address": [string,FCH地址]], "amount":[int64,金额, 单位为satoshi] } ], "output": [{ "index":[int,索引], "address": [string,FCH地址]], "amount":[int64,金额, 单位为satoshi] } ] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. signedRequest
9. rawTxBroadcast (交易广播接口)
在链上广播已经签名的原始交易。
- 请求参数
{ "rawTx": [string, 已签名的原始交易,必填] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
无响应参数。
- 返回值
仅通用返回值,OK或Unknown error。
APIP3V1_CIDInfo(zh-CN)
本协议接口提供CID相关的主要信息。数据来源和相关规则遵循以下协议:
- cid:《FEIP3_CID》
- homepage:《FEIP26_Homepage》
- noticeFee:《FEIP27_NoticeFee》
- master:《FEIP6_Master》
1. cidInfo (CID信息接口)
获取cid的地址、公钥、url、noticeFee和master等信息
- 请求参数
{ "address": [string,FCH地址,不可与cid同时查询], "cid": [string, CID, 不可与address同时查询] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "address": [string,FCH地址], "cid": [string, CID], "publicKey": [string, PublicKey], "url": [string, 链上注册的url(FEIP26_Homepage)], "noticeFee":[int, 链上注册的通知费(FEIP27_NoticeFee),单位satoshi], "master":[string, 链上声明的主控地址(FEIP6_Master)], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2000 The address has not been used. address 3000 The address has not registed CID. address 3001 The address has unregisted its CID. address 3002 The CID has been unregisted. cid 3003 Cannot query address and CID at the same time. signedRequest
2. cidInfoList (批量cid信息接口)
批量获取cid信息。
- 请求参数
{ "addressList": [[string array, fch地址列表,不与cid列表同时查询], "cidList": [[string array, cid列表,不与地址列表同时查询] }
- 响应参数
{ "cidInfoList": [{ "address": [string,FCH地址], "cid": [string, CID], "publicKey": [string, PublicKey], "url": [string, 链上注册的url], "noticeFee":[int, 链上注册的通知费,单位satoshi], "master":[string, 链上声明的主控地址] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 3004 Too many addresses are requested. maxAddress 3005 Address and cid cannot be queried at the same time signedRequest
3. cidHistory (cid历史接口)
获取按照《FEIP3_CID》上链的cid操作历史信息。
- 请求参数
{ "address": [string,FCH地址,不与cid同时查询], "cid": [string, CID, 包括已注销的cid,不与地址同时查询], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "address": [string,FCH地址], "opList": [{ "block": [int, 交易所在区块], "cid": [string, CID], "op": [string,data.op的值], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳] } ] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2000 The address has not been used. address 3000 The address has not registed CID. address 3003 Cannot query address and CID at the same time. signedRequest
4. homepageHistory (Homepage历史)
获取按照《FEIP26_Homepage》声明的cid的url历史信息。
- 请求参数
{ "address": [string,FCH地址], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "address": [string,FCH地址], "opList": [{ "block": [int, 交易所在区块], "url": [string, 链上注册的url], "op": [string,data.op的值], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳] } ] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2000 The address has not been used. address 3006 The address has not registed homepage. address
5. noticeFeeHistory (noticeFee历史)
获取按照《FEIP27_NoticeFee》声明的cid的noticeFee历史信息。
- 请求参数
{ "address": [string,FCH地址], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "address": [string,FCH地址], "opList": [{ "block": [int, 交易所在区块], "noticeFee":[int, 链上注册的通知费,单位satoshi], "op": [string,data.op的值], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳] } ] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2000 The address has not been used. address 3007 The address has not declared notice fee. address
6. cidSearch (CID搜索接口)
模糊搜索cid,不区分大小写。
- 请求参数
{ "searchContent": [string, 所要搜索的内容],必填", } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "cidList": [string array, cid列表]] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 3008 No cid containing this string was found. searchContent
APIP4V1_Reputation(zh-CN)
本协议接口提供链上声誉和相互评价相关的主要信息。数据来源和相关规则遵循以下协议:
- 《FEIP16_Reputation》
1. reputationList (声誉查询接口)
查询一个或多个地址的声誉值。
- 请求参数
{ "addressList": [[string array, fch地址列表], }
- 响应参数
{ "reputationList": [{ "address": [string,FCH地址]], "reputation": [int64, The value of reputation defined in "FEIPFEIP16_Reputation"], "tCdd": [int64,该地址累计销毁的币天], } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 3006 Too many addresses are requested. maxAddresses
2. ratedHistory (被评记录查询接口)
- 请求参数
{ "address": [string,FCH地址], "filterCdd": [string, 按销毁币天筛选,参见“通用约定·筛选参数”], "filterRater": [string, 按评价者筛选,参见“通用约定·筛选参数”], "filterRatingSign": [string, 按好评(+)和差评(-)筛选,参见“通用约定·筛选参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "address": [string,FCH地址], "ratedList": [{ "block": [int, 交易所在区块], "cdd": [int,本交易销毁币天], "rater": [string, 评价者地址], "ratingSign": [string, 好评(+)或差评(-)], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2000 The address has not been used. address 4000 No matching record. signedRequest
3. ratingHistory (主评记录查询接口)
获取某地址评价他人的历史记录。
- 请求参数
{ "address": [string,FCH地址], "filterCdd": [string, 按销毁币天筛选,参见“通用约定·筛选参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "filterRatedAddress": [string, 按被评价地址(ratedAddress)排序,参见“通用约定·筛选参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "address": [string,FCH地址], "ratingList": [{ "block": [int, 交易所在区块], "cdd": [int,本交易销毁币天], "ratedAddress": [string, 被评价者地址], "ratingSign": [string, 好评(+)或差评(-)], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 2000 The address has not been used. address 4000 No matching record. signedRequest
-
-
APIP5V1_ProtocolInfo(zh-CN)
本协议接口提供链上注册的各种协议的相关信息。数据来源和相关规则遵循以下协议:
- 《FEIP1_FreeProtocol》
1.pidInfoList (PID详情接口)
给定一个或多个PID获取相应协议详情。
- 请求参数
{ "pidList": [string array, 拟查询的pid列表,必填] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "pidInfoList": [{ "pid": [string, 协议的pid], "type": [string, 协议类型,data.type的值], "sn": [string,协议编号,data.sn的值], "ver": [string,协议版本号,data.ver的值], "name": [string,协议名,data.name的值], "lang": [string,协议的语言,data.lang的值,采用i18n标准], "title": [string,协议的标题,如"FEIP3V4_CID(en-US)"], "desc": [string,协议的描述,data.desc的值], "authors": [string array, 协议的作者们,data.authors的值], "prePid": [string,协议上一版本的pid,data.prePid的值], "fileUrl": [string,协议文件的url,data.fileUrl的值], "firstTxid": [string,协议发布的txid], "signer": [string,协议的签发者,即发布交易的第一个输入地址], "firstTime": [timestamp,发布时间戳], "lastTxid": [string,协议信息最后更新的txid], "lastTime": [timestamp,协议信息最后更新的时间戳], "tCdd": [int64, 该协议的评价交易累计销毁的币天], "tRate": [float, 协议的综合评分], "status": [bool, 协议的当前状态,1为生效中,0为已注销] } ] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 5000 These PIDs do not exist. missedPidList 5001 Too many PIDs are requested. maxPidCount
2. protocolSearch (协议搜索接口)
按条件查询协议。
- 请求参数
{ "filterTitle": [string, 模糊匹配title,参见“通用约定·筛选参数”], "filterAuthors": [string, 模糊匹配authors,参见“通用约定·筛选参数”], "filterType": [string, 模糊匹配type,参见“通用约定·筛选参数”], "filterLang": [string, 模糊匹配lang,参见“通用约定·筛选参数”], "filterPrePid": [string, 按prePid精确匹配,参见“通用约定·筛选参数”], "filterFileUrl": [string, 模糊匹配fileUrl,参见“通用约定·筛选参数”], "filterSigner": [string, 按第一个输入地址筛选], "filterFirstTime": [string, 按发布的交易时间筛选,参见“通用约定·筛选参数”], "filterLastTime": [string, 按发布的交易时间筛选,参见“通用约定·筛选参数”], "filterTCdd": [string, 按tCdd筛选,参见“通用约定·筛选参数”], "filterTRate": [string, 按tRate筛选,参见“通用约定·筛选参数”], "filterStatus": [string, 按status筛选,参见“通用约定·筛选参数”], "sortSigner": [string, 按第一个输入地址排序,参见“通用约定·排序参数”], "sortFirstTime": [string, 按发布的交易时间戳排序,参见“通用约定·排序参数”], "sortLastTime": [string, 按最后更新的交易时间戳排序,参见“通用约定·排序参数”], "sortTCdd": [string, 按累计销毁币天tCdd排序,参见“通用约定·排序参数”], "sortTRate": [string, 按综合评分tRate排序,参见“通用约定·排序参数”], "sortStatus": [string, 按当前状态排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "protocolList": [{ "pid": [string, 协议的pid], "title": [string,协议的标题,如"FEIP3V4_CID(en-US)"], "desc": [string,协议的描述,data.desc的值], "fileUrl": [string,协议文件的url,data.fileUrl的值], "signer": [string,协议的签发者,即发布交易的第一个输入地址], "firstTime": [timestamp,发布时间戳], "lastTime": [timestamp,协议信息最后更新的时间戳], "tCdd": [int64, 该协议的评价交易累计销毁的币天], "tRate": [float, 协议的综合评分], "status": [bool, 协议的当前状态,1为生效中,0为已注销] } ] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. signedRequest
3. pidHistory (协议历史接口)
查询某pid协议的所有历史操作记录,不包括data.op值为“rate”的记录。
- 请求参数
{ "pid": [string, 协议的pid], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] }
- 响应参数
{ "pid": [string, 协议的pid], "signer": [string,协议的签发者,即发布交易的第一个输入地址], "title": [string,协议的标题,如"FEIP3V4_CID(en-US)"], "opList ": [{ "op": [string, data.op的值,排除值为“rate”的项], "type": [string, data.type的值], "sn": [string,协议编号,data.sn的值], "ver": [string,协议版本号,data.ver的值], "name": [string,协议名,data.name的值], "lang": [string,协议的语言,data.lang的值,采用i18n标准], "title": [string,协议的标题,如"FEIP3V4_CID(en-US)"], "desc": [string,协议的描述,data.desc的值], "authors": [string array, 协议的作者们,data.authors的值], "prePid": [string,协议上一版本的pid,data.prePid的值], "fileUrl": [string,协议文件的url,data.fileUrl的值], "txid": [string, txid], "txTimestamp": [timestamp,交易的时间戳], "block": [int, 交易所在区块] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 5002 The PID does not exist. pid
4. pidRateList (协议评价列表接口)
查询对某pid协议的评价信息,即data.op值为“rate”的记录。
- 请求参数
{ "pid": [string, 协议的pid], "filterRate": [string, 按评分data.rate的值筛选,参见“通用约定·筛选参数”], "filterCdd": [string, 按销毁币天筛选,参见“通用约定·排序参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "filterRater": [string, 按评价者筛选,参见“通用约定·筛选参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "sortCdd": [string, 按销毁币天排序,参见“通用约定·排序参数”], "sortRate": [string, 按data.rate的值排序,参见“通用约定·排序参数”], "sortRater": [string, 按评价者排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] }
- 响应参数
{ "pid": [string, 协议的pid], "rateList ": [{ "rater": [string, 评价者地址], "rate": [uint, 评分data.rate的值], "cdd": [int64, 销毁币天值], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳], "block": [int, 交易所在区块] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 5002 The PID does not exist. pid 4000 No matching record. signedRequest
APIP6V1_ServiceInfo(zh-CN)
本协议接口提供链上注册的各项服务的相关信息。数据来源和相关规则遵循以下协议:
- 《FEIP29_Service》
1.sidInfoList (SID详情接口)
给定一个或多个SID获取相应服务详情。
- 请求参数
{ "sidList": [string array, 拟查询的sid列表,必填] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "sidInfoList": [{ "sid": [string, 服务的sid], "stdName": [string,服务的标准名, data.stdName的值], "localName": [string array,服务的其他名称, data.localName的值], "desc": [string,服务的描述,data.desc的值], "type": [string, 服务类型,data.type的值], "url": [string,服务的url,data.url的值], "pubKey": [string, 发布者指定的管理身份公钥,data.pubKey的值], "signer": [string,服务的签发者,即发布交易的第一个输入地址], "firstTime": [timestamp,发布时间戳], "lastTxid": [string,服务信息最后更新的txid], "lastTime": [timestamp,服务信息最后更新的时间戳], "tCdd": [int64, 该服务的评价交易累计销毁的币天], "tRate": [float, 服务的综合评分,tRate=(tCdd\*tRate+cdd\*rate)/(tCdd+cdd)], "status": [bool, 服务的当前状态,1为生效中,0为已注销] } ] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 6000 These SIDs do not exist. missedSidList 6001 Too many SIDs are requested. maxSidCount
2. serviceSearch (服务搜索接口)
按条件查询服务。
- 请求参数
{ "filterName": [string, 模糊匹配data.stdName或data.localName,参见“通用约定·筛选参数”], "filterAddress": [string, 模糊匹配data.pubKey所对应的address,参见“通用约定·筛选参数”], "filterType": [string, 模糊匹配data.type,参见“通用约定·筛选参数”], "filterUrl": [string, 模糊匹配data.url,参见“通用约定·筛选参数”], "filterSigner": [string, 按第一个输入地址筛选], "filterFirstTime": [string, 按发布的交易时间筛选,参见“通用约定·筛选参数”], "filterLastTime": [string, 按发布的交易时间筛选,参见“通用约定·筛选参数”], "filterTCdd": [string, 按tCdd筛选,参见“通用约定·筛选参数”], "filterTRate": [string, 按tRate筛选,参见“通用约定·筛选参数”], "filterStatus": [string, 按status筛选,参见“通用约定·筛选参数”], "sortSigner": [string, 按第一个输入地址排序,参见“通用约定·排序参数”], "sortFirstTime": [string, 按发布的交易时间戳排序,参见“通用约定·排序参数”], "sortLastTime": [string, 按最后更新的交易时间戳排序,参见“通用约定·排序参数”], "sortTCdd": [string, 按累计销毁币天tCdd排序,参见“通用约定·排序参数”], "sortTRate": [string, 按综合评分tRate排序,参见“通用约定·排序参数”], "sortStatus": [string, 按当前状态排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "serviceList": [{ "sid": [string, 服务的sid], "stdName": [string,服务的标准名, data.stdName的值], "localName": [string array,服务的其他名称, data.localName的值], "desc": [string,服务的描述,data.desc的值], "type": [string, 服务类型,data.type的值], "url": [string,服务的url,data.url的值], "pubKey": [string, 发布者指定的管理身份公钥,data.pubKey的值], "signer": [string,服务的签发者,即发布交易的第一个输入地址], "firstTime": [timestamp,发布时间戳], "lastTxid": [string,服务信息最后更新的txid], "lastTime": [timestamp,服务信息最后更新的时间戳], "tCdd": [int64, 该服务的评价交易累计销毁的币天], "tRate": [float, 服务的综合评分], "status": [bool, 服务的当前状态,1为生效中,0为已注销] } ] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. 没有符合条件的信息。
3. sidHistory (服务历史接口)
查询某sid服务的所有历史操作记录,不包括data.op值为“rate”的记录。
- 请求参数
{ "sid": [string, 服务的sid], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] }
- 响应参数
{ "sid": [string, 服务的sid], "signer": [string,服务的签发者,即发布交易的第一个输入地址], "stdName": [string,服务的标准名, data.stdName的最新值], "opList ": [{ "op": [string, data.op的值, 排除值为“rate”的项], "stdName": [string,服务的标准名, data.stdName的值], "localName": [string array,服务的其他名称, data.localName的值], "desc": [string,服务的描述,data.desc的值], "type": [string, 服务类型,data.type的值], "url": [string,服务的url,data.url的值], "pubKey": [string, 发布者指定的管理身份公钥,data.pubKey的值], "txid": [string, txid], "txTimestamp": [timestamp,交易的时间戳], "block": [int, 交易所在区块] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 6002 The SID does not exist. sid
4. sidRateList (服务评价列表接口)
查询对某sid服务的评价信息,即data.op值为“rate”的记录。
- 请求参数
{ "sid": [string, 服务的sid], "filterRate": [string, 按评分data.rate的值筛选,参见“通用约定·筛选参数”], "filterCdd": [string, 按销毁币天筛选,参见“通用约定·排序参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "filterRater": [string, 按评价者筛选,参见“通用约定·筛选参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "sortCdd": [string, 按销毁币天排序,参见“通用约定·排序参数”], "sortRate": [string, 按data.rate的值排序,参见“通用约定·排序参数”], "sortRater": [string, 按评价者排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] }
- 响应参数
{ "sid": [string, 服务的sid], "rateList ": [{ "rater": [string, 评价者地址], "rate": [uint, 评分data.rate的值], "cdd": [int64, 销毁币天值], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳], "block": [int, 交易所在区块] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 6002 The SID does not exist. sid 4000 No matching record. signedRequest
APIP7V1_CappInfo(zh-CN)
本协议接口提供链上注册的各中密码应用的相关信息。数据来源和相关规则遵循以下协议:
- 《FEIP15_CAPP》
1.aidInfoList (AID详情接口)
给定一个或多个AID获取相应应用详情。
- 请求参数
{ "aidList": [string array, 拟查询的aid列表,必填] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "aidInfoList": [{ "aid": [string, 应用的aid], "stdName": [string,应用的标准名, data.stdName的值], "localName": [string array,应用的其他名称, data.localName的值], "desc": [string,应用的描述,data.desc的值], "type": [string, 应用类型,data.type的值], "url": [string,应用的url,data.url的值], "prot": [string array, 所采用的协议pid,data.prot的值], "serv": [string array, 所采用的服务sid,data.serv的值], "pubKey": [string, 发布者指定的管理身份公钥,data.pubKey的值], "signer": [string,应用的签发者,即发布交易的第一个输入地址], "firstTime": [timestamp,发布时间戳], "lastTxid": [string,应用信息最后更新的txid], "lastTime": [timestamp,应用信息最后更新的时间戳], "tCdd": [int64, 该应用的评价交易累计销毁的币天], "tRate": [float, 应用的综合评分], "status": [bool, 应用的当前状态,1为生效中,0为已注销] } ] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 7000 These AIDs do not exist. missedAidList 7001 Too many AIDs are requested. maxAidCount
2. cappSearch (应用搜索接口)
按条件查询应用。
- 请求参数
{ "filterName": [string, 模糊匹配data.stdName或data.localName,参见“通用约定·筛选参数”], "filterAddress": [string, 模糊匹配data.pubKey所对应的address,参见“通用约定·筛选参数”], "filterType": [string, 模糊匹配data.type,参见“通用约定·筛选参数”], "filterUrl": [string, 模糊匹配data.url,参见“通用约定·筛选参数”], "filterProt": [string, 模糊匹配data.prot, 参见“通用约定·筛选参数”], "filterServ": [string, 模糊匹配data.serv,参见“通用约定·筛选参数”], "filterSigner": [string, 按第一个输入地址筛选], "filterFirstTime": [string, 按发布的交易时间筛选,参见“通用约定·筛选参数”], "filterLastTime": [string, 按发布的交易时间筛选,参见“通用约定·筛选参数”], "filterTCdd": [string, 按tCdd筛选,参见“通用约定·筛选参数”], "filterTRate": [string, 按tRate筛选,参见“通用约定·筛选参数”], "filterStatus": [string, 按status筛选,参见“通用约定·筛选参数”], "sortSigner": [string, 按第一个输入地址排序,参见“通用约定·排序参数”], "sortFirstTime": [string, 按发布的交易时间戳排序,参见“通用约定·排序参数”], "sortLastTime": [string, 按最后更新的交易时间戳排序,参见“通用约定·排序参数”], "sortTCdd": [string, 按累计销毁币天tCdd排序,参见“通用约定·排序参数”], "sortTRate": [string, 按综合评分tRate排序,参见“通用约定·排序参数”], "sortStatus": [string, 按当前状态排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "cappList": [{ "aid": [string, 应用的aid], "stdName": [string,应用的标准名, data.stdName的值], "localName": [string array,应用的其他名称, data.localName的值], "desc": [string,应用的描述,data.desc的值], "type": [string, 应用类型,data.type的值], "url": [string,应用的url,data.url的值], "prot": [string array, 所采用的协议pid,data.prot的值], "serv": [string array, 所采用的服务sid,data.serv的值], "pubKey": [string, 发布者指定的管理身份公钥,data.pubKey的值], "signer": [string,应用的签发者,即发布交易的第一个输入地址], "firstTime": [timestamp,发布时间戳], "lastTxid": [string,应用信息最后更新的txid], "lastTime": [timestamp,应用信息最后更新的时间戳], "tCdd": [int64, 该应用的评价交易累计销毁的币天], "tRate": [float, 应用的综合评分], "status": [bool, 应用的当前状态,1为生效中,0为已注销] } ] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. 没有符合条件的信息。
3. aidHistory (应用历史接口)
查询某aid应用的所有历史操作记录,不包括data.op值为“rate”的记录。
- 请求参数
{ "aid": [string, 应用的aid,必填], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "aid": [string, 应用的aid], "signer": [string,应用的签发者,即发布交易的第一个输入地址], "stdName": [string,应用的标准名, data.stdName的最新值], "opList ": [{ "op": [string, data.op的值, 排除值为“rate”的项], "stdName": [string,应用的标准名, data.stdName的值], "localName": [string array,应用的其他名称, data.localName的值], "desc": [string,应用的描述,data.desc的值], "type": [string, 应用类型,data.type的值], "url": [string,应用的url,data.url的值], "prot": [string array, 所采用的协议pid,data.prot的值], "serv": [string array, 所采用的服务sid,data.serv的值], "pubKey": [string, 发布者指定的管理身份公钥,data.pubKey的值], "txid": [string, txid], "txTimestamp": [timestamp,交易的时间戳], "block": [int, 交易所在区块] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 7002 The AID does not exist. aid
4. aidRateList (应用评价列表接口)
查询对某aid应用的评价信息,即data.op值为“rate”的记录。
- 请求参数
{ "aid": [string, 应用的aid, 必填], "filterRate": [string, 按评分data.rate的值筛选,参见“通用约定·筛选参数”], "filterCdd": [string, 按销毁币天筛选,参见“通用约定·排序参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "filterRater": [string, 按评价者筛选,参见“通用约定·筛选参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "sortCdd": [string, 按销毁币天排序,参见“通用约定·排序参数”], "sortRate": [string, 按data.rate的值排序,参见“通用约定·排序参数”], "sortRater": [string, 按评价者排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] }
- 响应参数
{ "aid": [string, 应用的aid], "rateList ": [{ "rater": [string, 评价者地址], "rate": [uint, 评分data.rate的值], "cdd": [int64, 销毁币天值], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳], "block": [int, 交易所在区块] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 7002 The AID does not exist. aid 4000 No matching record. signedRequest
-
APIP8V1_EncryptedInfoOnChain(zh-CN)
本协议接口提供密信、联系人、保险柜等链上加密信息。数据来源和相关规则遵循以下协议:
- 《FEIP7_MailOnChain》
- 《FEIP12_Contacts》
- 《FEIP17_Safe》
1. mailOnChain (链上密信接口)
根据筛选条件获取链上密信信息。
- 请求参数
{ "filterSender": [string, 按第一个输入地址筛选,参见“通用约定·筛选参数”], "filterRecipient": [string, 按第一个输出地址筛选,参见“通用约定·筛选参数”], "filterDeleted": [bool, 按是否已删除筛选,1为已删除,参见“通用约定·筛选参数”], "filterAlg": [string, 按加密算法即data.alg的值筛选,参见“通用约定·筛选参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "sortDeleted": [string, 按是否已删除排序,1为已删除,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "mailList": [{ "alg": [string, 加密算法,data.alg的值], "msgSend": [string, 第一个输入地址公钥加密的密文,data.msgSend的值], "msgReci": [string, 第一个输出地址公钥加密的密文,data.msgReci的值], "sender": [string, 第一个输入地址], "recipient": [string, 第一个输出地址], "deleted": [bool, 删除标记,1为已删除], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳], "block": [int, 交易所在区块], } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. signedRequest
2.contactsOnChain (链上联系人接口)
根据筛选条件获取链上联系人信息。
- 请求参数
{ "filterHost": [string, 按第一个输出地址筛选,参见“通用约定·筛选参数”], "filterOperator": [string, 按第一个输入地址筛选,参见“通用约定·筛选参数”], "filterDeleted": [bool, 按是否已删除筛选,1为已删除,参见“通用约定·筛选参数”], "filterAlg": [string, 按加密算法即data.alg的值筛选,参见“通用约定·筛选参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "sortDeleted": [string, 按是否已删除排序,1为已删除,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "contactList": [{ "alg": [string, 加密算法,data.alg的值], "msg": [string, 第一个输出地址公钥加密的密文,data.msg的值], "host": [string, 第一个输出地址], "operator": [string, 第一个输入地址], "deleted": [bool, 删除标记,1为已删除], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳], "block": [int, 交易所在区块], } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. signedRequest
3.safeOnChain (链上保险柜接口)
根据筛选条件获取链上保险柜信息。
- 请求参数
{ "filterHost": [string, 按第一个输出地址筛选,参见“通用约定·筛选参数”], "filterOperator": [string, 按第一个输入地址筛选,参见“通用约定·筛选参数”], "filterDeleted": [bool, 按是否已删除筛选,1为已删除,参见“通用约定·筛选参数”], "filterAlg": [string, 按加密算法即data.alg的值筛选,参见“通用约定·筛选参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "sortDeleted": [string, 按是否已删除排序,1为已删除,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "safeList": [{ "alg": [string, 加密算法,data.alg的值], "msg": [string, 第一个输出地址公钥加密的密文,data.msg的值], "host": [string, 第一个输出地址], "operator": [string, 第一个输入地址], "deleted": [bool, 删除标记,1为已删除], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳], "block": [int, 交易所在区块], } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. signedRequest
APIP9V1_GroupInfo(zh-CN)
本协议接口提供链上注册的各种群的相关信息。数据来源和相关规则遵循以下协议:
- 《FEIP19_Group》
1.gidInfoList (gid列表接口)
给定一个或多个gid获取除成员列表以外的群信息。
- 请求参数
{ "gidList": [string array, gid列表, 必填] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "gidInfoList": [{ "gid": [string, 群的gid], "name": [string,群名,data.name的值], "desc": [string,群的描述,data.desc的值], "memberNumber": [uint64, 活跃成员的数量], "sponsor": [string, 创建群的交易的第一个输入地址], "updater": [string, 最后更新群信息的交易的第一个输入地址], "firstTime": [timestamp,发布时间戳], "lastTxid": [string, 群信息最后更新的txid], "lastTime": [timestamp,群信息最后更新的时间戳], "tCdd": [int64, 该群创建、更新和加群操作的所有交易累计销毁的币天] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 9000 These GIDs do not exist. missedGidList 9001 Too many GIDs are requested. maxGidCount
2. gidDetails (群详情接口)
给定一个gid获取其包括群成员在内的全部信息。
- 请求参数
{ "gid": [string, 群的gid,必填] }
- 响应参数
{ "gid": [string, 群的gid], "name": [string,群名,data.name的值], "desc": [string,群的描述,data.desc的值], "memberNumber": [uint64, 活跃成员的数量], "activeMembers": [string array, 活跃成员名单], "exitedMembers": [string array, 已退出成员名单], "sponsor": [string, 创建群的交易的第一个输入地址], "updater": [string, 最后更新群信息的交易的第一个输入地址], "firstTime": [timestamp,发布时间戳], "lastTxid": [string,群信息最后更新的txid], "lastTime": [timestamp,群信息最后更新的时间戳], "tCdd": [int64, 该群创建、更新和加群操作的所有交易累计销毁的币天] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 9002 The GID does not exist. gid
3. groupSearch (群搜索接口)
按条件查询群。
- 请求参数
{ "filterName": [string,模糊匹配data.name,参见“通用约定·筛选参数”], "filterDesc": [string,模糊匹配data.desc,参见“通用约定·筛选参数”], "filterSponsor": [string, 模糊匹配sponsor,参见“通用约定·筛选参数”], "filterUpdater": [string, 模糊匹配updater,参见“通用约定·筛选参数”], "filterMemberNumber": [string,按memberNumber筛选,参见“通用约定·筛选参数”], "filterFirstTime": [string, 按发布的交易时间筛选,参见“通用约定·筛选参数”], "filterLastTime": [string, 按发布的交易时间筛选,参见“通用约定·筛选参数”], "filterTCdd": [string, 按tCdd筛选,参见“通用约定·筛选参数”], "sortMemberNumber": [string,按memberNumber排序,参见“通用约定·排序参数”], "sortFirstTime": [string, 按发布的交易时间戳排序,参见“通用约定·排序参数”], "sortLastTime": [string, 按最后更新的交易时间戳排序,参见“通用约定·排序参数”], "sortTCdd": [string, 按累计销毁币天tCdd排序,参见“通用约定·排序参数”], "sortName": [string, 按data.name排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] }
- 响应参数
{ "gidInfoList": [{ "gid": [string, 群的gid], "name": [string,群名,data.name的值], "desc": [string,群的描述,data.desc的值], "memberNumber": [uint64, 活跃成员的数量], "sponsor": [string, 创建群的交易的第一个输入地址], "updater": [string, 最后更新群信息的交易的第一个输入地址], "firstTime": [timestamp,发布时间戳], "lastTxid": [string, 群信息最后更新的txid], "lastTime": [timestamp,群信息最后更新的时间戳], "tCdd": [int64, 该群创建、更新和加群操作的所有交易累计销毁的币天] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. signedRequest
4. gidHistory (群历史接口)
查询某gid群的所有历史操作记录。
- 请求参数
{ "gid": [string, 群的gid, 必填], "filterSigner": [string, 按第一个输入地址筛选,参见“通用约定·筛选参数”], "filterOp": [string, 按datga.op筛选,参见“通用约定·筛选参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "filterCdd": [string, 按cdd筛选,参见“通用约定·筛选参数”], "sortOp": [string, 按data.op排序,参见“通用约定·排序参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "sortCdd": [string, 按销毁币天排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "gid": [string, 群的aid], "name": [string,群名, data.name的最新值], "opList ": [{ "op": [string, data.op的值], "signer": [string,群的创建者,即建群交易的第一个输入地址], "name": [string,群名, data.name的值], "desc": [string,群的描述,data.desc的值], "txid": [string, txid], "txTimestamp": [timestamp,交易的时间戳], "cdd": [int, 本交易销毁币天], "block": [int, 交易所在区块] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 9002 The GID does not exist. gid
5. gidMemberSearch (群成员搜索接口)
模糊查询某gid群的某个cid或地址,不区分大小写。
- 请求参数
{ "gid": [string, 群的gid,必填], "searchMember": [string, 在cid和address中模糊搜索的内容,必填] }
- 响应参数
{ "gid": [string, 查询的群的gid], "memberList": [string array, 包含searchMember的cid或address列表] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. 没有符合条件的信息。
6. myGroupList (我的群列表接口)
模糊查询某address当前参与和已经退出的群列表。
- 请求参数
{ "address": [string,FCH地址,必填], "filterMemberStatus": [string, 按成员状态筛选,包括“active”和“exited”两种状态,参见“通用约定·筛选参数”], }
- 响应参数
{ "gidInfoList": [{ "memberStatus": [string, 在该群的成员状态,“active”或“exited”], "gid": [string, 群的gid], "name": [string,群名,data.name的值], "desc": [string,群的描述,data.desc的值], "memberNumber": [uint64, 活跃成员的数量], "sponsor": [string, 创建群的交易的第一个输入地址], "updater": [string, 最后更新群信息的交易的第一个输入地址], "firstTime": [timestamp,发布时间戳], "lastTxid": [string, 群信息最后更新的txid], "lastTime": [timestamp,群信息最后更新的时间戳], "tCdd": [int64, 该群创建、更新和加群操作的所有交易累计销毁的币天] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. 没有符合条件的信息。
APIP10V1_OrganizationInfo(zh-CN)
本协议接口提供链上注册的各种组织的相关信息。数据来源和相关规则遵循以下协议:
- 《FEIP28_Organization》
1.oidInfoList (组织概况列表接口)
给定一个或多个oid获取除成员列表以外的组织信息。
- 请求参数
{ "oidList": [string array, oid列表, 必填] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "oidInfoList": [{ "oid": [string, 组织的oid], "owner": [string, 创建组织的交易的第一个输入地址], "stdName": [string,组织的标准名, data.stdName的值], "localName": [string array,组织的其他名称, data.localName的值], "desc": [string,组织的描述,data.desc的值], "memberNumber": [uint64, 活跃成员的数量], "firstTime": [timestamp,创建交易的时间戳], "lastTxid": [string, 组织最新操作的txid], "lastTime": [timestamp,组织最新操作的时间戳], "tCdd": [int64, data.op为“rate”的所有交易的累计币天销毁], "tRate": [float, 服务的综合评分,tRate=(tCdd\*tRate+cdd\*rate)/(tCdd+cdd)] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 1100 These OIDs do not exist. missedOidList 1101 Too many OIDs are requested. maxOidCount
2. memberList (组织成员列表接口)
获取oid的各种状态的成员列表。
- 请求参数
{ "oid": [string, 组织的oid,必填], "filterMemberStatus": [string, 按成员状态筛选,包括“owner”,“active”,“administrators”,“exiting”和“delisted”5种状态,参见“通用约定·筛选参数”], }
- 响应参数
{ "oid": [string, 组织的oid], "owner": [string, 创建组织的交易的第一个输入地址], "activeMembers": [string array, 活跃成员名单], "exitingMembers": [string array, 已申请退出尚未除名的成员名单], "administrators": [string array, 管理员名单], "delistedMembers": [string array, 已除名成员名单], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 1102 The OID does not exist. oid
3. organizationSearch (组织搜索接口)
按条件查询组织。
- 请求参数
{ "filterStdName": [string,模糊匹配data.stdName,参见“通用约定·筛选参数”], "filterLocalName": [string,模糊匹配data.localName,参见“通用约定·筛选参数”], "filterDesc": [string,模糊匹配data.desc,参见“通用约定·筛选参数”], "filterMemberNumber": [string,按memberNumber筛选,参见“通用约定·筛选参数”], "filterFirstTime": [string, 按发布的交易时间筛选,参见“通用约定·筛选参数”], "filterLastTime": [string, 按发布的交易时间筛选,参见“通用约定·筛选参数”], "filterTCdd": [string, 按累计币天销毁tCdd筛选,参见“通用约定·筛选参数”], "filterTRate": [string, 按总和评分tRate筛选,参见“通用约定·筛选参数”], "sortMemberNumber": [string,按memberNumber排序,参见“通用约定·排序参数”], "sortFirstTime": [string, 按发布的交易时间戳排序,参见“通用约定·排序参数”], "sortLastTime": [string, 按最后更新的交易时间戳排序,参见“通用约定·排序参数”], "sortTCdd": [string, 按累计销毁币天tCdd排序,参见“通用约定·排序参数”], "sortStdName": [string, 按data.stdName排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] }
- 响应参数
{ "oidInfoList": [{ "oid": [string, 组织的oid], "owner": [string, 创建组织的交易的第一个输入地址], "stdName": [string,组织的标准名, data.stdName的值], "localName": [string array,组织的其他名称, data.localName的值], "desc": [string,组织的描述,data.desc的值], "memberNumber": [uint64, 活跃成员的数量], "firstTime": [timestamp,发布时间戳], "lastTxid": [string, 组织信息最后更新的txid], "lastTime": [timestamp,组织信息最后更新的时间戳], "tCdd": [int64, data.op为“rate”的所有交易的累计币天销毁], "tRate": [float, 服务的综合评分,tRate=(tCdd\*tRate+cdd\*rate)/(tCdd+cdd)] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. signedRequest
4. oidHistory (组织历史接口)
查询某oid组织的除rate操作外的所有历史操作记录。
- 请求参数
{ "oid": [string, 组织的oid, 必填], "filterSigner": [string, 按第一个输入地址筛选,参见“通用约定·筛选参数”], "filterOp": [string, 按除了“rate”以外的10种datga.op值筛选,参见“通用约定·筛选参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "sortOp": [string, 按data.op排序,参见“通用约定·排序参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] } //请求还需加入timestamp、API的url(post)、requester、sign,用于验证身份和数据,参见“流程”或原协议.
- 响应参数
{ "oid": [string, 组织的aid], "stdName": [string,组织的标准名, data.stdName的值], "opList ": [{ "op": [string, data.op的值], "signer": [string,组织的创建者,即建组织交易的第一个输入地址], "recipients": [string array, 所有输出地址列表], "stdName": [string,组织的标准名, data.stdName的值], "localName": [string array,组织的其他名称, data.localName的值], "desc": [string,组织的描述,data.desc的值], "days": [string,邀请的有效时间,data.days的值], "txid": [string, txid], "txTimestamp": [timestamp,交易的时间戳], "cdd": [int, 本交易销毁币天], "block": [int, 交易所在区块] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 1102 The OID does not exist. oid
5. oidMemberSearch (组织成员搜索接口)
在活跃成员中模糊查询某oid组织的某个cid或地址,不区分大小写。
- 请求参数
{ "oid": [string, 组织的oid,必填], "searchMember": [string, 在cid和address中模糊搜索的内容,必填] }
- 响应参数
{ "oid": [string, 查询的组织的oid], "memberList": [string array, 包含searchMember的cid或address列表] "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. 没有符合条件的信息。
6. myGroupList (我的组织列表接口)
模糊查询某address当前拥有、当前参与、担任管理员、声明退出或已经退出的组织列表。
- 请求参数
{ "address": [string,FCH地址,必填], "filterMemberStatus": [string, 按成员状态筛选,包括“owner”,“active”,“administrators”,“exiting”和“delisted”5种状态,参见“通用约定·筛选参数”], }
- 响应参数
{ "oidInfoList": [{ "memberStatus": [string, 在该组织的成员状态,“owner”,“active”,“administrators”,“exiting”和“delisted”5种状态之一], "oid": [string, 组织的oid], "owner": [string, 创建组织的交易的第一个输入地址], "stdName": [string,组织的标准名, data.stdName的值], "localName": [string array,组织的其他名称, data.localName的值], "desc": [string,组织的描述,data.desc的值], "memberNumber": [uint64, 活跃成员的数量], "firstTime": [timestamp,发布时间戳], "lastTxid": [string, 组织信息最后更新的txid], "lastTime": [timestamp,组织信息最后更新的时间戳], "tCdd": [int64, data.op为“rate”的所有交易的累计币天销毁], "tRate": [float, 服务的综合评分,tRate=(tCdd\*tRate+cdd\*rate)/(tCdd+cdd)] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 4000 No matching record. 没有符合条件的信息。
7. oidRateList (组织评价列表接口)
查询对某oid组织的评价信息,即data.op值为“rate”的记录。
- 请求参数
name type description required oid string Y filterRate uint Filter by data.rate N filterCdd string Filter by cdd N filterTxTimestamp string Filter by txTimestamp N filterRater string Filter by the address of the first input of the rating transaction N sortTxTimestamp string Sort by txTimestamp N sortCdd string Sort by cdd N sortRate string Sort by data.rate N sortRater string Sort by the address of the first input of the rating transaction N count uint How many entries are wanted in a single request. N sequence uint Sequence in continuous request.Start from 0. N - 请求参数
{ "oid": [string, 组织的oid], "filterRate": [string, 按评分data.rate的值筛选,参见“通用约定·筛选参数”], "filterCdd": [string, 按销毁币天筛选,参见“通用约定·排序参数”], "filterTxTimestamp": [string, 按交易时间戳筛选,参见“通用约定·筛选参数”], "filterRater": [string, 按评价者筛选,参见“通用约定·筛选参数”], "sortTxTimestamp": [string, 按交易时间戳排序,参见“通用约定·排序参数”], "sortCdd": [string, 按销毁币天排序,参见“通用约定·排序参数”], "sortRate": [string, 按data.rate的值排序,参见“通用约定·排序参数”], "sortRater": [string, 按评价者排序,参见“通用约定·排序参数”], "count": [int,本次请求数量,参见“通用约定·批量请求”], "sequence": [int, 本次请求批次,参见“通用约定·批量请求”] }
- 响应参数
{ "oid": [string, 组织的oid], "rateList ": [{ "rater": [string, 评价者地址], "rate": [uint, 评分data.rate的值], "cdd": [int64, 销毁币天值], "txid": [string,交易id], "txTimestamp": [timestamp,交易的时间戳], "block": [int, 交易所在区块] } ], "heignt": [uint,响应时的最新区块高度] } //响应时还需加入sign,用于验证数据,参见“流程”或原协议.
- 返回值
code msg data 1102 The OID does not exist. oid 4000 No matching record. signedRequest