Open API 接口手册

OpenAPI 手册 包含神策智能运营提供的 OpenAPI 列表和每个 API 的详细信息。该手册会在产品每次版本发布时更新。是开发人员使用 OpenAPI 的主要参考。

Open API 接口 URL 地址

HTTP API 分为两种：

• 离线接口 offline：即调用频率不高的元数据控制相关的接口，如查询受众列表、启动触发策略、订阅属性标签等查询、修改接口；
• 在线接口 online：即调用频率非常高的接口，有 QPS 和接口性能要求，目前仅有受众服务的受众在线判定接口、属性标签订阅服务的属性查询接口；

两种接口获取请求 host 的方式不一样：

• 离线接口的 host 即为 SA 的 host，如您的系统登录地址为（示例）：http://my.sensorsdata.cn:8107，则离线接口的  host 为：http://my.sensorsdata.cn:8107
• 在线接口的 host 需要通过神策的系统页面获取，获取路径为：项目设置 → 在线服务地址 → 数据接入 - 弹窗 SDK 在线数据接收地址 → 复制数据接收地址，复制后的地址中的 http://host:port 即为在线服务的请求 host，注意去掉 /api/v2/。

API 是使用 HTTP 还是 HTTPS，由集群入口的负载均衡决定，在集群接入时配置。

Open API 接口认证

当进行一次 HTTP 请求时，往往还需要一些其他信息：

关于 api-key 的概念，请参阅官网文档：https://manual.sensorsdata.cn/sa/docs/open_api_authentication

在请求接口返回时，会返回如下结构数据：

{
    "code": "SUCCESS",
    "message": null,
    "request_id": "94076ab01ef942448c702c9335f3d4a2",
    "data": {},
    "error_info": null
}

其中返回的各个参数释义如下：