概述

神策各个产品有着丰富的 API 体系。神策 OpenAPI 通过标准化产品 API ,提供了丰富的产品能力扩展。使用 OpenAPI ,用户可以方便地进行定制化和自动化。下面将介绍神策 OpenAPI 的一些基本概念和使用方式。

基本概念

版本

OpenAPI 中的基础路径,携带了两类版本信息:API 大版本和接口版本,如/api/v3/portal/v2。其中 v3表示 API 版本,该版本号基本不会变动,只有在整个API框架升级时变更。v2表示某个产品下的接口版本。接口版本可能随着产品升级而更新。同一版本中的接口保持兼容性。接口版本和产品版本无必然联系,产品的多个版本可以使用同一个接口版本,即表示该接口在这些产品版本中保持不变。

OpenAPI 风格

神策 OpenAPI 风格类似 RESTful 。不同点在于,为了减少参数形式的复杂度,OpenAPI 请求中,不会出现路径参数,即请求参数只会在 http query 和 body 中出现。并且,带复杂结构体的请求参数,都放在 body 中。具体可参考每个 API 中的参数说明。

使用方式

OpenAPI手册

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

访问地址

OpenAPI 的访问地址,由集群的入口地址决定,通常是集群请求的负载均衡地址或域名。访问某个 API 时,需要替换 OpenAPI手册 展示的URL中的主机部分 ${sensors_data_url}, 如: http://${sensors_data_url}/api/v3/portal/v2/management/behavior/list

HTTP和HTTPS

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

认证方式

所有 API 都需要通过认证才能调用,具体认证方式参考: OpenAPI认证方式