OPEN API

简述

开发者可以通过开放接口实现特定功能需求。

查询画像

开发者可以通过用户id列表获取画像信息。

接口定义

• 接口地址: $BaseUrl/query_tag
• 请求方式: POST
• content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

body参数说明

• 入参字段定义

• 入参示例

{
    "userIdList":[
      "xxxxxx--1","xxxxxx--2"
    ]
}

Response响应说明

• 出参data字段定义

• http code: 200(http code码说明)
• 正常响应出参示例

{
  "data": {
    "validTags": [            // 有效标签列表
      {
        "userId": "gtcid1",            // 用户id
        "tags": {            // 标签信息
          "custom": [            // 自定义标签code列表
            "自定义标签code1",
            "自定义标签code2"
          ],
          "gt": [            // 个推标签code列表
            "个推标签code1",
            "个推标签code1"
          ],
          "external": [            // 客户自有标签code列表（暂不支持）
            "客户自有标签code"
          ]
        }
      }
    ],
    "invalidTags": [            // 无效标签列表
      {
        "userId": "gtcid2",            // 用户id
        "msg": "用户暂无画像",            // 错误信息
        "code": 105            // 错误码
      }
    ]
  },
  "code": "0",            // 响应code码
  "msg": "成功"                // 响应信息
}

个推标签code码说明文档

请求示例

curl $BaseUrl/query_tag \
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
     "userIdList":[
          "gtcid1","gtcid2"
     ]
 }'

数据导入

开发者可以通过接口导入数据。

接口定义

• 接口地址: $BaseUrl/import
• 请求方式: POST
• content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

body参数说明

• 入参字段定义

• 入参示例

{
    "templateId":3124,
    "dataList":[
      "xxxxxx--1","xxxxxx--2"
    ]
}

Response响应说明

• http code: 200(http code码说明)
• 正常响应出参示例

{
    "msg": "成功",            // 响应信息
    "code": 0            // 响应code码
}

请求示例

curl $BaseUrl/import \
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
     "templateId":1324,
     "dataList":[
          "xxxxxx--1","xxxxxx--2"
     ]
 }'