鉴权与请求
使用 Pipispy 开放平台账号对应的 API Key 完成请求鉴权。
管理 API Key
打开控制台查看和管理你的 API Key。请将密钥保存在服务端环境变量或应用的密钥管理服务中。
JSON 请求结构
大多数数据接口接收包含三个字段的 JSON 请求体:
| 字段 | 类型 | 说明 |
|---|---|---|
key | string | 开放平台 API Key。 |
uri | string | 接口文档指定的接口路径。 |
params | object | 该接口需要的请求参数。 |
{
"key": "YOUR_API_KEY",
"uri": "/v3/api/open/adspy/list",
"params": {
"current_page": 1,
"page_size": 10
}
}
请求头设置 Content-Type: application/json 和 Accept: application/json。密钥通过请求体中的 key 传入,不使用 Bearer Token。
选择正确的网关
| 网关地址 | 用途 |
|---|---|
https://www.pipispy.com/open-api/v1/data | 常规数据查询、图片 URL 搜索提交。 |
https://www.pipispy.com/open-api/v1/monitor/data | 广告监控接口。 |
https://www.pipispy.com/open-api/v1/upload-file | multipart 图片上传。 |
请以具体接口文档的请求地址和格式为准。图片上传使用的请求体格式与普通 JSON 查询不同。
保管好密钥
在服务端发起请求,不要把密钥放入 URL、前端代码、公开仓库或日志。如果密钥泄露,请使用控制台提供的账号管理功能更换,或联系支持团队处理。