本API的出发点是希望使用者不需要关注具体的计划,定时去取已经下载的文件即可;例如今天去取昨天所有下载的文件即可。
一、 公司获取报表数据
1. 接口地址:
https://rpa-server.ziniao.com/erp_report/list
2. 请求类型:POST
3. 请求参数
body:
{ "rpaIdList": [1,2,3], "startTime": "2021-01-01 00:00:00", "endTime": "2021-01-02 00:00:00", "page": 1, "limit": 10 }
参数说明
名称 | 类型 | 是否必须 | 说明 |
token | string | 必须 | 放在请求头里的token字段,企业对接密钥(见V1.0.3更新说明)注意使用utf8编码。 |
rpaIdList | int array | 非必须 | RPAID列表 |
startTime | string | 非必须 | 起始时间,对报表文件上传服务器时间进行筛选 |
endTime | string | 非必须 | 结束时间,对报表文件上传服务器时间进行筛选 |
Page | int | 非必须 | 当前分页,默认第1页 |
Limit | int | 非必须 | 每页展示条数,默认10条, 最大每次500条 |
成功返回结果:
{ "code": 0, "msg": "SUCCESS", "data": { "count": 1, "result": [{ "id": 1, "url": "下载URL地址", "rpaId": 1, "name": "报表名称", "rpaName": "RPA名称", "storeName": "店铺名称", "siteName": "美国", "siteNameEn": "US", "startTime": "2021-01-01", "endTime": "2021-01-01", "finishTime": "2021-01-01 00:10:00", "sellerId": "卖家ID", "marketplaceId": "站点ID" }] } }
失败返回结果:
{ "code": 10000, "msg": "错误消息提示" }
返回结果参数说明:
名称 | 类型 | 说明 |
count | int | 数据总个数 |
id | int | 报表ID |
url | string | 报表下载url(需要进行urldecode),地址有效期为3天 |
rpaId | int | RPAID |
name | String | 报表名称 |
rpaName | string | RPA名称 |
storeName | string | 店铺名称 |
siteName | string | 站点名称 |
siteNameEn | String | 站点名称(英文) |
platfromType | int | 平台类型 (0:Amazon 1:速卖通 2:Lazada 3:Ebay 4:paypal 5:沃尔玛) |
start_time | string | 报表开始时间 |
end_time | string | 报表结束时间 |
finishTime | string | 报表文件生成上传服务器时间 |
sellerId | string | 卖家ID |
marketplacerId | string | 站点ID |
接口参数例子:
RPA ID查看方法:
在【我的RPA】中可查看RPA ID
本API的出发点是希望使用者不需要关注具体的计划,定时去取已经下载的文件即可;例如今天去取昨天所有下载的文件即可。
二、 公司获取报表错误数据
1. 接口地址:
https://rpa-server.ziniao.com/erp_report/list/errors
2. 请求类型:GET
3. 请求参数
body:
{ "rpaIdList": [1,2,3], "startTime": "2021-01-01 00:00:00", "endTime": "2021-01-02 00:00:00", "page": 1, "limit": 10 }
参数说明
名称 | 类型 | 是否必须 | 说明 |
token | string | 必须 | 放在请求头里的token字段,企业对接密钥(见V1.0.3更新说明)注意使用utf8编码。 |
rpaIdList | int array | 非必须 | RPAID列表 |
startTime | string | 非必须 | 起始时间,对报表创建时间进行筛选 |
endTime | string | 非必须 | 结束时间,对报表创建时间进行筛选 |
Page | int | 非必须 | 当前分页,默认第1页 |
Limit | int | 非必须 | 每页展示条数,默认10条, 最大每次500条 |
成功返回结果:
{ "code": 0, "msg": "SUCCESS", "data": { "count": 1, "result": [{ "id": 1, "url": "下载URL地址", "rpaId": 1, "name": "报表名称", "rpaName": "RPA名称", "storeName": "店铺名称", "siteName": "美国", "siteNameEn": "US", "startTime": "2021-01-01", "endTime": "2021-01-01", "finishTime": "2021-01-01 00:10:00", "sellerId": "卖家ID", "marketplaceId": "站点ID", "errorMessage": "错误信息" }] } }
失败返回结果:
{ "code": 10000, "msg": "错误消息提示" }
返回结果参数说明:
名称 | 类型 | 说明 |
count | int | 数据总个数 |
id | int | 报表ID |
url | string | 报表下载url(需要进行urldecode),地址有效期为3天 |
rpaId | int | RPAID |
name | String | 报表名称 |
rpaName | string | RPA名称 |
storeName | string | 店铺名称 |
siteName | string | 站点名称 |
siteNameEn | String | 站点名称(英文) |
platfromType | int | 平台类型 (0:Amazon 1:速卖通 2:Lazada 3:Ebay 4:paypal 5:沃尔玛) |
start_time | string | 报表开始时间 |
end_time | string | 报表结束时间 |
finishTime | string | 报表文件生成上传服务器时间 |
sellerId | string | 卖家ID |
marketplacerId | string | 站点ID |
errorMessage | string | 错误信息 |
接口参数例子:
RPA ID查看方法:
在【我的RPA】中可查看RPA ID
三、 第三方获取报表数据
1. 接口地址:
https://rpa-server.ziniao.com/erp_report/list
2. 请求类型:POST
3. 请求参数
body:
{ "startTime": "2021-01-01 00:00:00", "endTime": "2021-01-02 00:00:00", "page": 1, "limit": 10, "secretKey":"*********" }
参数说明
名称 | 类型 | 是否必须 | 说明 |
token | string | 必须 | 放在请求头里的token字段,第三方授权密钥, 由Boss在API设置中授权第三方后生成, 授权前第三方需要先联系运营申请账号。 |
startTime | string | 非必须 | 起始时间,对报表文件上传服务器时间进行筛选 |
endTime | string | 非必须 | 结束时间,对报表文件上传服务器时间进行筛选 |
secretKey | string | 必须 | 第三方账号,第三方服务商请联系运营申请账号 |
page | int | 非必须 | 分页,默认第1页 |
limit | int | 非必须 | 每页展示条数,默认10条, 最大每次500条 |
成功返回结果:
{ "code": 0, "msg": "SUCCESS", "data": { "count": 1, "result": [{ "id": 1, "url": "下载URL地址", "rpaId": 1, "name": "报表名称", "rpaName": "RPA名称", "storeName": "店铺名称", "siteName": "美国", "siteNameEn": "US", "startTime": "2021-01-01", "endTime": "2021-01-01", "finishTime": "2021-01-01 00:10:00", "sellerId": "卖家ID", "marketplaceId": "站点ID" }] } }
失败返回结果:
{ "code": 10000, "msg": "错误消息提示" }
名称 | 类型 | 说明 |
count | int | 数据总个数 |
id | int | 报表ID |
url | string | 报表下载url(需要进行urldecode),地址有效期为3天 |
rpaId | int | RPAID |
name | String | 报表名称 |
rpaName | string | RPA名称 |
storeName | string | 店铺名称 |
siteName | string | 站点名称 |
siteNameEn | String | 站点名称(英文) |
platfromType | int | 平台类型 (0:Amazon 1:速卖通 2:Lazada 3:Ebay 4:paypal 5:沃尔玛) |
start_time | string | 报表开始时间 |
end_time | string | 报表结束时间 |
finishTime | string | 报表文件生成上传服务器时间 |
sellerId | string | 卖家ID |
marketplacerId | string | 站点ID |
接口参数例子:
Python SDK:get_cloud_rpa_report_list
# coding: utf-8 import json import requests class Config(object): def __init__(self): self.host = None self.token = None def set_config(self, env): if not env: return {"ret": 10001, "msg": u"参数不能为空"} if env == "sim": self.host = "https://rpa-server-pre.ziniao.com/erp_report/list" elif env == "pro": self.host = "https://rpa-server.ziniao.com/erp_report/list" class ReportInfos(Config): def __init__(self): super(ReportInfos, self).__init__() self.page = 1 self.limit = 10 self.rpaIdList = [] self.startTime = None self.endTime = None self.header = {"User-Agent": "Mozilla/5.0 (Windows NT 6.1; Trident/7.0; rv:11.0) like Gecko", "Content-Type": "application/json", "token": config.token} self.host = config.host def get_param_body(self): param = {"page": self.page, "limit": self.limit} if self.rpaIdList: param["rpaIdList"] = self.rpaIdList if self.startTime: param["startTime"] = self.startTime if self.endTime: param["endTime"] = self.endTime return param def query_report_list(self, param): """ 获取数据库实例下的table名称 :return: """ try: json_data = json.dumps(param).encode(encoding='utf-8') res = requests.post(url=self.host, data=json_data, headers=self.header) if res.status_code not in range(200, 300): return {"ret": 10002, "msg": u"请求服务器失败"} response_data = json.loads(res.content) if response_data.get("code") != 0: return {"ret": 10002, "msg": response_data.get("msg", u"服务端代码异常")} data = response_data.get("data") return {"ret": 0, "msg": u"获取数据成功", "data": data.get("result"), "count": response_data.get("count")} except Exception as e: print e return {"ret": 10003, "msg": u"获取异常", "error_msg": e.message} if __name__ == '__main__': # 链接参数配置 config = Config() config.set_config(env="pro") config.token = "" # 初始化请求结构参数 report_infos = ReportInfos() # 分页默认一页10条 report_infos.page = 1 report_infos.limit = 10 report_infos.rpaIdList = [] report_infos.startTime = "2021-07-20 00:00:00" report_infos.endTime = "2021-07-25 00:00:00" param = report_infos.get_param_body() # 请求报表信息 report_result = report_infos.query_report_list(param) print report_result
四、第三方根据RPAID获取对应的授权店铺
1.接口地址:
https://rpa-server.ziniao.com/erp_report/list_authorized_store
2.请求类型:POST
3.请求参数
body:
{ "rpaId": 0, "secretKey": "**********" }
参数说明
名称 | 类型 | 是否必须 | 说明 |
token | string | 必须 | 放在请求头里的token字段,第三方授权密钥, 由Boss在API设置中授权第三方后生成, 授权前第三方需要先联系运营申请账号。 |
rpaId | Long | 必须 | RpaId |
secretKey | string | 必须 | 第三方账号,第三方服务商请联系运营申请账号 |
成功返回结果:
{ "code": 0, "msg": "SUCCESS", "data": [ "T00002", "T00003", "T00001" ] }
失败返回结果:
{ "code": 10000, "msg": "错误消息提示" }
名称 | 类型 | 说明 |
code | int | 成功状态码 |
data | array[] | 返回店铺名称数组 |
接口参数例子: