game2006api/doc/AAMarket.py
aozhiwei 0dcd21ee52 1
2024-07-23 19:16:54 +08:00

381 lines
16 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import _common
class AAMarket(object):
def __init__(self):
self.apis = [
{
'method': 'POST',
'name': '/api/market/product/list/:net_id',
'desc': '获取上架出售的NFTs(瀑布流式api) jwtheader为可选参数',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/market/product/list/:net_id',
'headers': _common.JwtHeader,
'is_json_params': True,
'request_params': [
[':net_id', 0, '链id'],
],
'params': [
['page_size', 0, '每页大小'],
['cursor', '', '游标 第一页传空'],
['search', [
['name', '', '名字查询 空(所有)'],
], '模糊查询'],
['filter', [
['price_min', '', '价格下限 空(无下限)'],
['price_max', '', '价格上限 空(无上限)'],
['!item_ids', [0], '道具id列表 空(所有)'],
['!hero_ranks', [0], '英雄品阶列表 空(所有)']
], '过滤条件'],
['sort', [
['!fields', [
['name', '', '字段名 目前支持的字段(price)'],
['type', 0, '排序方式 -1:倒序 0:默认排序 1:正序'],
], '排序字段']
], '排序规则'],
],
'response': [
_common.RspHead(),
['page', _common.StreamPage(), '分页信息'],
['!rows', [_common.MarketGoods()], '数据'],
]
},
{
'method': 'GET',
'name': '/api/market/product/query_price',
'desc': '查询在售卖商品价格',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/market/product/query_price',
'params': [
['net_id', 0, '链id'],
['contract_address', '', '合约地址'],
['item_id', '', '道具id'],
['quality', '', '道具品质(目前只有Hero生效)'],
],
'response': [
_common.RspHead(),
['lowest_price_goods', _common.MarketGoods(), '最低价格商品(如果没则为null)'],
['highest_price_goods', _common.MarketGoods(), '最高价格商品(如果没则为null)'],
]
},
{
'method': 'GET',
'name': '/api/market/product/goods/:net_id/:contract_address/:token_id',
'desc': '获取单个商品信息',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/market/product/goods/:net_id/:contract_address/:token_id',
'params': [
[':net_id', 0, '链id'],
[':contract_address', '', '合约地址'],
[':token_id', '', 'token_id'],
],
'response': [
_common.RspHead(),
['data', _common.MarketGoods(), '商品信息(如果没则为null), 如果未上架则data.event==null'],
]
},
{
'method': 'GET',
'name': '/api/market/product/category/:net_id',
'desc': '获取上架出售的NFTs分类数量',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/market/product/category/:net_id',
'params': [
[':net_id', 0, '链id'],
],
'response': [
_common.RspHead(),
['!data', [
['item_id', 0, '道具id'],
['num', 0, '商品数量'],
], '分类数量'],
]
},
{
'name': '/api/market/transaction/history/:net_id/:account_address',
'desc': '获取账号交易历史',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/market/transaction/history/:net_id/:account_address',
'params': [
[':net_id', 0, '链id'],
[':account_address', '', '钱包地址'],
['type', '', '0:全部 1:买进 2卖出'],
['page_size', 0, '每页大小'],
['cursor', '', '游标 第一页传空'],
['search_name', '', 'nft名字 空(所有)'],
],
'response': [
_common.RspHead(),
['page', _common.StreamPage(), '分页信息'],
['!rows', [_common.SaleGoods()], '数据'],
]
},
{
'name': '/api/asset/:net_id/:account_address',
'desc': '获取账号资产',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/asset/:net_id/:account_address',
'params': [
[':net_id', 0, '链id'],
[':account_address', '', '钱包地址'],
['type', '', '0:全部 1:上架中 2:未上架 3:质押中'],
['page_size', 0, '每页大小'],
['cursor', '', '游标 第一页传空'],
['search_name', '', 'nft名字 空(所有)'],
],
'response': [
_common.RspHead(),
['page', _common.StreamPage(), '分页信息'],
['!rows', [_common.AssetNftInfo()], '数据'],
]
},
{
'method': 'GET',
'name': '/api/listing/:net_id/:account_address',
'desc': '获取自己上链商品',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/listing/:net_id/:account_address',
'params': [
[':net_id', 0, '链id'],
[':account_address', '', '钱包地址'],
['page_size', 0, '每页大小'],
['cursor', '', '游标 第一页传空'],
['search_name', '', 'nft名字 空(所有)'],
],
'response': [
_common.RspHead(),
['page', _common.StreamPage(), '分页信息'],
['!data', [_common.MarketGoods()], '数据'],
]
},
{
'method': 'GET',
'name': '/api/shopcart/list',
'desc': '购物车-商品列表',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/shopcart/list',
'headers': _common.JwtHeader,
'permission': _common.LoginRequired,
'params': [
],
'response': [
_common.RspHead(),
['!data', [_common.MarketGoods()], '数据'],
]
},
{
'method': 'POST',
'name': '/api/shopcart/add',
'desc': '购物车-添加商品',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/shopcart/add',
'headers': _common.JwtHeader,
'permission': _common.LoginRequired,
'is_json_params': True,
'params': [
['net_id', 0, '链id'],
['!tokens', [
['token_id', '', 'token_id'],
['contract_address', '', 'contract_address'],
], 'nft list']
],
'response': [
_common.RspHead(),
]
},
{
'method': 'POST',
'name': '/api/shopcart/del',
'desc': '购物车-删除商品',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/shopcart/del',
'headers': _common.JwtHeader,
'permission': _common.LoginRequired,
'is_json_params': True,
'params': [
['net_id', 0, '链id'],
['!tokens', [
['token_id', '', 'token_id'],
['contract_address', '', 'contract_address'],
], 'nft list']
],
'response': [
_common.RspHead(),
]
},
{
'method': 'POST',
'name': '/api/shopcart/clear',
'desc': '购物车-清空购物车',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/shopcart/clear',
'headers': _common.JwtHeader,
'permission': _common.LoginRequired,
'params': [
['net_id', 0, '链id'],
],
'response': [
_common.RspHead(),
]
},
{
'method': 'POST',
'name': '/api/nft/stacking/unlock',
'desc': '质押-unlock',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/nft/stacking/unlock',
'headers': _common.JwtHeader,
'permission': _common.LoginRequired,
'is_json_params': True,
'params': [
['net_id', 0, '链id'],
['contract_address', '', 'contract_address'],
['!tokens', [
['token_id', '', 'token_id'],
], 'nft list(目前只支持英雄并且只支持一个)']
],
'response': [
_common.RspHead(),
['trans_id', '', '事务id'],
['trans_req', _common.MFTransactionRequest(), '调用合约参数'],
]
},
{
'method': 'POST',
'name': '/api/ingame/asset/hero/list',
'desc': '获取游戏内资产-英雄',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/ingame/asset/hero/list',
'headers': _common.JwtHeader,
'is_json_params': True,
'request_params': [
],
'params': [
['page_size', 0, '每页大小'],
['cursor', '', '游标 第一页传空'],
['search', [
['name', '', '名字查询 空(所有)'],
], '模糊查询'],
['filter', [
['!item_ids', [0], '道具id列表 空(所有)'],
['!hero_ranks', [0], '英雄品阶列表 空(所有)']
], '过滤条件'],
['sort', [
['!fields', [
], '排序字段']
], '排序规则'],
],
'response': [
_common.RspHead(),
['page', _common.StreamPage(), '分页信息'],
['!rows', [_common.MarketGoods()], '数据'],
]
},
{
'method': 'POST',
'name': '/api/ingame/asset/hero/mint',
'desc': '游戏内资产-英雄mint',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/ingame/asset/hero/mint',
'headers': _common.JwtHeader,
'permission': _common.LoginRequired,
'is_json_params': True,
'params': [
['to_address', '', '目标address'],
['!hero_uniids', [''], '英雄uniid列表(目前只支持1个)'],
],
'response': [
_common.RspHead(),
['trans_id', '', '事务id'],
['trans_req', _common.MFTransactionRequest(), '调用合约参数'],
]
},
{
'method': 'GET',
'name': '/api/user/:account_address',
'desc': '获取用户信息',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/user/:account_address',
'params': [
],
'response': [
_common.RspHead(),
['contribution_point', 0, '贡献点'],
['gold', 0, '金币数'],
]
},
{
'method': 'GET',
'name': '/api/activity/stacking/expected_daily/:account_address',
'desc': '质押活动-获取每日预期所得',
'group': '!AAMarket',
'url': '/api/activity/stacking/expected_daily/:account_address',
'params': [
],
'response': [
_common.RspHead(),
['contribution_point', 0, '贡献点'],
]
},
{
'method': 'GET',
'name': '/api/activity/stacking/history/:account_address',
'desc': '质押活动-获取每日所得历史记录',
'group': '!AAMarket',
'url': '/api/activity/stacking/history/:account_address',
'params': [
],
'response': [
_common.RspHead(),
['!rows', [
['date', 0, '日期utc时间'],
['contribution_point', 0, '贡献点'],
], '数据'],
]
},
{
'method': 'GET',
'name': '/api/chain/txhash/:net_id/:txhash',
'desc': '返回txhash是否已被服务器确认',
'group': '!AAMarket',
'url': '/api/chain/txhash/:net_id/:txhash',
'params': [
],
'response': [
_common.RspHead(),
['confirmed', 0, '是否已确认'],
]
},
{
'method': 'POST',
'name': '/api/chain/event/activity/:account_address',
'desc': '获取钱包链活动',
'group': '!AAMarket',
'url': 'https://market-test.kingsome.cn/api/chain/activity/:account_address',
'is_json_params': True,
'request_params': [
],
'params': [
['page_size', 0, '每页大小'],
['cursor', '', '游标 第一页传空'],
['search', [
['name', '', '名字查询 空(所有)'],
], '模糊查询'],
['filter', [
['!item_ids', [0], '道具id列表 空(所有)'],
], '过滤条件'],
['sort', [
['!fields', [
['name', '', '字段名 目前支持的字段'],
['type', 0, '排序方式 -1:倒序 0:默认排序 1:正序'],
], '排序字段']
], '排序规则目前无'],
],
'response': [
_common.RspHead(),
['page', _common.StreamPage(), '分页信息'],
['!rows', [_common.ChainActivity()], '数据'],
]
},
]