1. 接口描述
接口请求域名： trp.tencentcloudapi.com 。
新增溯源信息
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateTraceData。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-15。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| CorpId | 否 | Integer | 企业ID 示例值：1000 |
| BatchId | 否 | String | 批次ID 示例值：07wa9ed1l4yl |
| TaskId | 否 | String | 任务ID 示例值：1 |
| Phase | 否 | Integer | 溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源 示例值：1 |
| PhaseName | 否 | String | 溯源阶段名称 示例值：名称 |
| ChainStatus | 否 | Integer | [无效] 上链状态 示例值：1 |
| Type | 否 | Integer | [无效] 码类型 0: 批次, 1: 码, 2: 生产任务, 3: 物流信息 示例值：1 |
| TraceId | 否 | String | [无效] 溯源ID 示例值：9cz33jTOBIcKir4glzAS |
| TraceItems.N | 否 | Array of TraceItem | 溯源信息 |
| Status | 否 | Integer | 溯源状态 0: 无效, 1: 有效 示例值：1 |
| PhaseData | 否 | PhaseData | 环节数据 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TraceId | String | 溯源ID 示例值：9cz33jTOBIcKir4glzAS |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 新增溯源信息
新增溯源信息
输入示例
POST / HTTP/1.1
Host: trp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTraceData
<公共请求参数>
{
"TraceItems": [
{
"Key": "name",
"Name": "名称",
"Value": "xltest",
"Type": "text",
"ReadOnly": true,
"Hidden": false,
"Values": [],
"Ext": "",
"Attrs": [],
"List": []
},
{
"Key": "avatar",
"Name": "主图",
"Value": "",
"Type": "image",
"ReadOnly": false,
"Hidden": false,
"Values": [
"https://webcdn.m.qq.com/anxin/public/4054d20b71d30db847492eecc8057e90.jpg"
],
"Ext": "",
"Attrs": [],
"List": []
},
{
"Key": "message",
"Name": "提示文本",
"Value": "商品信息溯源详情",
"Type": "text",
"ReadOnly": false,
"Hidden": false,
"Values": [],
"Ext": "",
"Attrs": [],
"List": []
},
{
"Key": "desc",
"Name": "卡片描述",
"Value": "二维码已完成扫码，请查看信息",
"Type": "text",
"ReadOnly": false,
"Hidden": false,
"Values": [],
"Ext": "",
"Attrs": [],
"List": []
}
],
"PhaseName": "设计阶段",
"PhaseData": {
"AppId": "",
"AppName": "",
"AppPath": "",
"HeadEnabled": false,
"HeadTitle": "",
"Key": ""
},
"Status": 1,
"Type": 1,
"Phase": 2,
"ChainStatus": 1,
"CorpId": 10000
}输出示例
{
"Response": {
"TraceId": "1mO3n3W0LDhAaADGwHjj3",
"RequestId": "eaa3ccac-d2f5-4df0-a8b3-7b51324e9283"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
