生活服务

电商

医疗

法律咨询

解决方案配置

解决方案测试实体管理接口

我的收藏

1.名词解释

点击【抖音开放平台-控制台-开发-解决方案配置】拖拉鼠标到页面最后能看到方案配置视图。

方案配置：

点击去管理能进入某个解决方案配置详情页面

解决方案配置详情页面：

在解决方案配置详情页面中，每个扩展点或消息订阅都有一个生产地址和测试地址

生产地址：正常运行时回调开发者的地址

测试地址：在上线前测试或者需要预览确认，开发者可以配置一个测试地址，回调时会回调测试地址，避免对开发者生产环境造成干扰

2.背景说明

目前各行业开发者有一些测试诉求，需要在特定情况下回调他们的测试环境而非生产环境，我们经过综合评估确定了如下方案

•

开发者首先通过本文介绍的OpenAPI录入测试实体，OpenApi当前仅支持测试商品

•

抖音后端调用扩展点或发送消息时会判断当前链路是否包含测试实体，如果包含则回调上面开发者配置的测试地址，如果不包含则回调开发者生产地址

举例说明：在创建订单时包含了开发者录入的测试商品，则在相关链路上，如退款，履约所有场景涉及回调开发者的，均回调测试地址。

3.前置条件

使用此接口需要满足以下条件：

•

小程序有解决方案权限，并能够看到解决方案菜单选项，拥有扩展点、消息权限（默认已授权），且拥有当前API的scope权限（默认已授权）

•

解决方案开放能力（扩展点、消息）支持测试实体和测试环境，具体可参见:解决方案支持测试环境的扩展点、消息汇总

•

小程序已获取开放能力（扩展点、消息）的权限，并配置了测试地址、生产地址，并完成构建至测试环境

4.接口列表

4.1 新增测试实体接口

4.1.1 基本信息

接口URL	https://open.douyin.com/api/industry/v1/solution/add_app_test_relation
通信协议	POST
通用参数	参见通用参数中公共参数部分

4.1.2 字段说明

请求参数

名称	类型	是否必须	描述	示例值
operator	string	是	当次请求操作人	小王
type	string	是	测试实体类型，测试商品传'goods',当前仅支持测试商品	goods
ref_id_list	List<string>	是	测试实体id列表，测试商品时传测试商品spu id列表，一个小程序最多支持20个测试商品，如果超过还想新增，需要调用4.3删除接口删除部分再新增当前仅支持使用抖音平台商品库的商品id	["7176108397883017260","7101120811901126700"]

响应参数

名称	类型	描述
extra	string	包含详细错误信息提示，用于定位问题的logid，时间信息等。
data	string	包含错误码（error_code）和错误提示（description），当请求成功返回时，error_code 为 0。

4.1.3 请求示例

curl --location --request POST 'https://open.douyin.com/api/industry/v1/solution/add_app_test_relation/' \
--header 'Content-Type: application/json' \
--header 'Access-Token: clt.fd8df35457bfa32d2d35995e53361169QseLIOdpnrC6tiWBq3CWH7L8s4mo' \
--data-raw '{
    "type": "goods",
    "ref_id_list": [
        "7176108397883017260","7101120811901126700"
    ],
    "operator": "小王"
}'

4.1.4 响应示例

正常情况

{
  "extra": {
    "logid": "202301111424086A0BFBC6E9DA5697FBCF",
    "now": 1673418248,
    "error_code": 0,
    "description": "",
    "sub_error_code": 0,
    "sub_description": "success"
  },
  "data": {
    "error_code": 0,
    "description": ""
  }
}

异常情况

{
  "extra": {
    "error_code": 2100005,
    "logid": "20230111144506BDBE52C1277CDDC08895",
    "now": 1673419506,
    "sub_description": "type is not right,only 'goods' is now used as type",
    "sub_error_code": 1000000000,
    "description": "参数不合法"
  },
  "data": {
    "error_code": 2100005,
    "description": "参数不合法"
  }
}

4.2 查询测试实体接口

4.2.1 基本信息

接口URL	https://open.douyin.com/api/industry/v1/solution/query_app_test_relation
通信协议	POST
通用参数	参见通用参数中公共参数部分

4.2.2 字段说明

请求参数

名称	类型	是否必须	描述	示例值
type	string	是	测试实体类型，测试商品传'goods'	goods

响应参数

名称	类型	描述
extra	string	包含详细错误信息提示，用于定位问题的logid，时间信息等。
data	string	包含错误码（error_code）和错误提示（description），当请求成功返回时，error_code 为 0。
ref_id_list	List<string>	测试实体id列表，测试商品时返回测试商品spu id列表

4.2.3 请求示例

curl --location --request POST 'https://open-boe.douyin.com/api/industry/v1/solution/query_app_test_relation/' \
--header 'Access-Token: clt.fd8df35457bfa32d2d35995e53361169QseLIOdpnrC6tiWBq3CWH7L8s4mo' \
--header 'Client_info: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "goods"
}'

4.2.4 响应示例

正常情况

{
  "ref_id_list": [
    "7176108397883017260",
    "7101120811901126700"
  ],
  "extra": {
    "logid": "202301111424086A0BFBC6E9DA5697FBCF",
    "now": 1666595790,
    "error_code": 0,
    "description": "",
    "sub_error_code": 0,
    "sub_description": "success"
  },
  "data": {
    "error_code": 0,
    "description": ""
  }
}

异常情况

{
  "extra": {
    "error_code": 2100005,
    "logid": "20230111144506BDBE52C1277CDDC08895",
    "now": 1673419506,
    "sub_description": "type is not right,only 'goods' is now used as type",
    "sub_error_code": 1000000000,
    "description": "参数不合法"
  },
  "data": {
    "error_code": 2100005,
    "description": "参数不合法"
  }
}

4.3 删除测试实体接口

4.3.1 基本信息

接口URL	https://open.douyin.com/api/industry/v1/solution/delete_app_test_relation
通信协议	POST
通用参数	参见通用参数中公共参数部分

4.3.2 字段说明

请求参数

名称	类型	是否必须	描述	示例值
operator	string	是	当次请求操作人	小王
type	string	是	测试实体类型，测试商品传'goods',当前仅仅支持测试商品	goods
ref_id_list	List<string>	是	测试实体id列表，测试商品时传测试商品spu id列表	["7176108397883017260","7101120811901126700"]

响应参数

名称	类型	描述
extra	string	包含详细错误信息提示，用于定位问题的logid，时间信息等。
data	string	包含错误码（error_code）和错误提示（description），当请求成功返回时，error_code 为 0。

4.3.3 请求示例

curl --location --request POST 'https://open.douyin.com/api/industry/v1/solution/delete_app_test_relation/' \
--header 'Content-Type: application/json' \
--header 'Access-Token: clt.fd8df35457bfa32d2d35995e53361169QseLIOdpnrC6tiWBq3CWH7L8s4mo' \
--data-raw '{
    "type": "goods",
    "ref_id_list": [
        "7176108397883017260","7101120811901126700"
    ],
    "operator": "小王"
}'

4.3.4 响应示例

正常情况

{
  "extra": {
    "logid": "202301111424086A0BFBC6E9DA5697FBCF",
    "now": 1666594475,
    "error_code": 0,
    "description": "",
    "sub_error_code": 0,
    "sub_description": "success"
  },
  "BaseResp": {
    "StatusMessage": "success",
    "StatusCode": 0
  }
}

异常情况

{
  "extra": {
    "error_code": 2100005,
    "logid": "20230111144147DC0FAA86CF1FB4AA7F23",
    "now": 1673419308,
    "sub_description": "type is not right,only 'goods' is now used as type",
    "sub_error_code": 1000000000,
    "description": "参数不合法"
  },
  "data": {
    "description": "参数不合法",
    "error_code": 2100005
  }
}