第三方API文档

API-新增店铺授权

2022-07-26 377

简要描述

通过 sellerId 申请指定店铺的 rpa 运行权限。返回成功授权的店铺信息。服务器再收到请求后会用指定的sellerId与紫鸟平台托管的店铺进行比对，可以匹配的店铺才能授权成功

请求URL

/rpa/stores/authorizations

请求方式

POST

支持格式

JSON

请求参数

Headers

参数名	参数描述	必选	类型	说明
Authorization	身份令牌	是	string	AppToken

Body

参数名	参数描述	必选	类型	说明
sellerId	需要授权的卖家ID	是	String
rpaIdList	需要授权的rpaid列表	是	String

提交数据样例

[
    {
        "sellerId":"123",
        "rpaIdList":[2222,12312,123]
    }
]

返回数据

参数名	参数描述	必选	类型	说明
requsetId	状态码	请求Id	string	当不能马上返回匹配结果时，会触发异步回调流程，此时会生成请求Id，异步回调结果中会携带该Id与之对应
code	状态码	是	number	-
msg	提示信息	否	string(1024)	-
data	业务数据	是	object	-
-sellerId	卖家店铺id	是	string(128)	-
-auth	授权状态	是	boolean	店铺是否授权成功
-rpaList	被授权的rpa列表	是	Object	-
--auth	被授权的rpa列表	是	String(4)	RPA是否授权成功
--id	RPA_ID	是	String(32)	-
--msg	提示信息	是	String(1024)	-

立即返回匹配结果时数据样例

此时code为 0

   {
    "requsetId": "123",
    "code": 0,
    "msg": "SUCCESS"
    "data": [
        {
            "sellerId": "123",
            "msg": "授权成功",
            "auth": true,
            "rpaList": [
                {
                     "auth": true,
                      "id": "111",
                      "msg": "授权成功"
                },
                {
                      "auth": false,
                      "id": "3333",
                      "msg": "授权失败"
                }
            ]
            
        }
    ]   
}

无法立即返回匹配结果时数据样例

此时code为 4102

  {
     "requsetId": "123",
     "code": 4102,
     "msg": "店铺同步中"
 }

授权结果异步回调

生态中新统一最外层数据格式

参数名	参数描述	必选	类型	说明
appKey	接收方appKey	是	string	-
messageType	消息类型	是	number	对于RPA的回调，值为300
companyId	公司ID	否	string(1024)	未正式启用，值默认未0
extra	业务数据	是	string	`目前业务数据是字符串形式的JOSN，解析时需要注意转义字符，业务数据的格式参考下面2业务数据格式`

外层样例数据

{
     "appKey": "100",
     "messageType": "300",
     "companyId":"0",
     "extra":"[{\"key\":\"value\"}]"
}

内层数据格式

参数名	参数描述	必选	类型	说明
requsetId	状态码	请求Id	string	当不能马上返回匹配结果时，会触发异步回调流程，此时会生成请求Id，异步回调结果中会携带该Id与之对应
code	状态码	是	number	-
type	回调消息类型	是	string	-3004 为店铺授权回调
msg	提示信息	否	string(1024)	-
data	业务数据	是	object	`目前业务数据是字符串形式的JOSN，解析时需要注意转义字符`
-sellerId	卖家店铺id	是	string(128)	-
-auth	授权状态	是	boolean	店铺是否授权成功
-rpaList	被授权的rpa列表	是	Object	-
--auth	被授权的rpa列表	是	String(4)	RPA是否授权成功
--id	RPA_ID	是	String(32)	-
--msg	提示信息	是	String(1024)	-

回调样例

{
    "requestId": "123123",
    "type": "3004",
    "code": 0,
    "msg": "SUCCESS"
    "data": [
        {
            "sellerId": "123",
             "msg": "授权成功",
            "auth": true,
            "rpaList": [
                {
                    "auth": true,
                      "id": "111",
                      "msg": "授权成功"
                }
            ]
        }
    ]   
}

本文导读