提示

📌

后续旧版本接口不再继续维护，请尽快迁移至新版本
旧版本接口文档

开发步骤

1.申请应用Key & Secret

💡

操作指引与特性说明：
1️⃣ 权限要求：由您团队内的SEVC系统管理员账号进行授权开通，保障账户安全。
2️⃣ 自主管理：开通后，团队成员可自行创建、配置与管理APP Key，灵活对接不同内部系统或业务模块。
3️⃣ 灵活配置：支持根据业务场景创建不同的APP Key，实现调用隔离与权限细分。我们为每个团队提供多达10个APP Key配额，足以覆盖您绝大多数业务对接需求。
4️⃣ 安全说明：API密钥一旦创建将长期有效，泄露可能导致业务数据外泄或资产安全隐患，请您妥善保管。

开通账号：
由管理员账号在「设置-开放平台- API信息配置」中点击「立即开通」按钮申请。
已开通的团队可直接「添加/编辑API账号」

添加/编辑账号：
编辑和管理每个API账号的权限（站点权限、不同接口权限）
出于您的数据安全性和私密性考虑，您可以根据需要对API账号的权限进行设置，来管理不同账号的API数据权限

将获取到的API密钥交给实际操作的IT团队或技术开发人员。

2.调用API

使用SDK调用API

JAVA

1.SDK包

下载链接

2.POM依赖

<dependency>
  <groupId>com.spotter.api.gateway</groupId>
  <artifactId>sdk-core-java</artifactId>
  <version>1.0.0</version>
</dependency>

3.验证ak、sk

Python

1.SDK包

下载链接

2.requirements.txt

spotter_openapi_sdk==1.0.0

3.验证ak、sk

SDK 通过环境变量读取 APP_KEY 和 APP_SECRET，相关变量如下

SPOTTER_BASE_URL  基础的 URL，默认是https://openapi.spotterio.com 
SPOTTER_APP_KEY     APP_KEY项
SPOTTER_APP_SECRET  APP_SECRET项

参考代码

3.错误码说明

code	返回值	状态描述	问题排查策略
400	Bad Request: errMsg	请求错误	根据errMsg核对接口文档
401	Unauthorized	没有被授权或者授权已经失效	核对应用Key & Secret
404	Not Found	资源未找到	核对该接口路径
429	Too Many Requests	请求过多	降低接口请求速率
500	Internal Server Error	服务器内部错误	联系账号经理处理

开发指南

开发步骤#

1.申请应用Key & Secret#

2.调用API#

使用SDK调用API#

JAVA#

1.SDK包#

2.POM依赖#

3.验证ak、sk#

Python#

1.SDK包#

2.requirements.txt#

3.验证ak、sk#

3.错误码说明#

开发步骤

1.申请应用Key & Secret

2.调用API

使用SDK调用API

JAVA

1.SDK包

2.POM依赖

3.验证ak、sk

Python

1.SDK包

2.requirements.txt

3.验证ak、sk

3.错误码说明