You need to enable JavaScript to run this app.
导航
概述
最近更新时间:2023.10.08 10:43:09首次发布时间:2023.10.08 10:43:09
1.可视化建模 Open API 概述

可视化建模(也称 Prep)提供丰富多样的数据清洗、筛选、聚合、机器学习等算子,支持用户创建任务,进行数据的抽取、转换能力,输出至数据集以供后续的标签、分群、分析洞察使用。本平台将Prep强大的数据处理能力通过 Open API 的方式提供出来,为客户提供更灵活的业务处理方式。您通过使用 Open API,实现和可视化建模同样的效果。可视化建模 Open API 涵盖了可视化建模的所有基础能力。

2.基本概念

2.1 鉴权相关

1) Client
Client是用户服务和Prep服务通信的凭证,包含Client Id、Client Secret两部分。其中Client Id是该通信凭证在Prep系统中的唯一Id,Client Secret是该通信凭证的秘钥。在请求Open API前,用户服务需要使用Client信息来获取需要请求的用户的Token。
2)Token
Token代表某一用户的身份信息,可使用Client信息请求Prep系统来获取。有了Token后,就可以在请求中带上Token来请求Prep系统了。

2.2 可视化建模相关概念

1)可视化建模
是指通过简单的可视化Web界面,完成专业的数据清洗、筛选、聚合、机器学习等复杂的数据ETL操作。
2) 任务、子任务
任务是一个完整的数据处理逻辑的集合,包含数据节点的属性、数据任务的调度、数据异常报警等。
3) 数据集
数据集是可视化分析的基础,是一组有特殊意义的数据集合。用户需将需要分析的数据导入到数据集,方可进行后续的报表制作工作。

3.准备阶段

在调用系统接口前,你需要先申请连接系统的Client,Client包括Client Id和Client Secret。接着通过Client Id和Client Secret来获取指定用户的Token。然后就可以使用Token通过开放接口来请求系统服务啦。

3.1 申请Client

如果你是客户数据平台的系统管理员,你申请的得到的Client和秘钥是系统级别的。如果你不是客户数据平台的系统管理员,你申请得到的Client和秘钥是用户级别的。

(如果你所在的环境是位于火山引擎,并且需要使用到系统级Client来调用Prep Open API,请联系客户数据平台的运维人员进行评估然后添加。)

申请人获取Token的范围
用户级Client普通用户自己
系统级Client系统管理员所有用户Token

申请Client需要开发者获取自己在系统中的sessionid,然后通过使用session_id来调用auth/client接口进行Client的获取。

下图举例说明了如何找到自己的sessionid。

3.2 获取用户Token

当你拥有一个Client之后,请将你的Client信息保存下来,这是获取用户Token的凭证。通过调用auth/token,附带上Client信息和需要获取Token的用户名,即可得到访问Open API的Token。

在请求具体业务相关Open API的时候,将token放入Header中即可。格式为 Authorization: Bearer+空格+Token。

例如:

keyvalue
AuthorizationBearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoib3BlbmFwaSIsInVzZXJuYW1lIjoiZ3VvaGFpc2h1YWkiLCJ1c2VyX3BheWxvYWQiOnt9LCJleHAiOjE2NTQ4NDgwOTMsImNsaWVudF9pZCI6ImNjYmQ4Mjg4ODZkZTRmOTRkODc2ZDQ4MTRhMGE1ODE3In0.WOfrqVWU40eZx-TgfhxMJ1TyuOiAhh98QLYtcNUE-f5q06qNN4bUv7ZD0tX6F8K9OqlIzBzXro-5pfRrcC4u4cBPnvuzl9etb8C3Nh0eAFlmqQrSZR5auNl9EaF8UaVuCSFlfal9aocUT2Re8JQN2UT_ww4y9GIZFhhBkjYZV--sBNuCh2B0UdjfwLEvevwOL-pW04pC81xLM5_aFX9FHa6TYK96o8dVLrHNjhQU2huh4D1il9UG9HAA_z6nhNyvuYcgs6ZZcapanuMc4YnTRPrmGdnoXMFFNImq6N3z943ACUrdinnM19TCj4fcKER3ZQ3XFT6UUnjHtn9sJ7rU4yvW9AcHBazVmjwscHwx0ooKe2pCMTiBa9QHi-R3nHIsuevx_AweiIZQ7vJCQ1PAve7mZVUi25QOlYJJCGiZmxd778sNX8M-BGFsGCLNugLMy1gaptTSma7YhQ-SwRt_Qxeeo3O6FgkyJMLnDHldwtYpcI6X2QUztAX4a4fzTwMMxTFIq0E_Az2xaz3O4-tX959o9KG93rD1EMWJKXn2IvrZjAA-7x-2d_HNVvl5NyDTvhTFRK8uYL1ZXPSSsBZXEhMuzJRpSawJohEUzgoYwNUGx75J15ZOmXRkeQm2J7OE3HEwHCrJ6zShZ7M8bFdjB1TZVoD2Mph4YroNq2jZbfE
4.常见返回码

1) 正常返回

{
  "code": "prep/ok",
  "extra_msg": null,
  "msg": "成功"
}

2) Token过期

{
    "code": "prep/openAPI/tokenExpired",
    "message": "token已过期"
}

3) Token不正确

{
    "code": "prep/openAPI/tokenError",
    "message": "token不正确"
}

4) 触发限流

{
    "code": "prep/openAPI/rateLimit",
    "message": "请求被限流"
}
5.接口文档

因为部署环境不同,Prep User Open API的实际域名会有不同,后续的的API地址中采用{domain}来代替域名,实际使用时换成具体域名即可。(详细说明见该模块下的对应接口文档)