Appearance
接口概览
Cookie Plus 提供了一套 REST API 开放接口,开发者可以通过编程方式管理域名、上传下载 Cookie 和 LocalStorage 数据。用于无头浏览器自动化测试等场景。
基础信息
| 项目 | 说明 |
|---|---|
| 基础地址 | https://cookieplus.perk-net.com/api/ |
| 协议 | HTTPS |
| 数据格式 | JSON |
| 认证方式 | Token(请求头携带) |
认证方式
所有开放接口均需要通过授权令牌(Token)进行身份认证。首先通过 accessKey 和 secretKey 获取授权令牌,然后在请求头中携带:
http
token: <your-api-token>Token 有效期为 7200 秒(2 小时),过期后需重新获取。详细说明请参考 获取授权令牌。
通用响应格式
所有接口返回统一的 JSON 格式:
成功响应:
json
{
"code": 200,
"msg": "执行成功",
"data": {}
}失败响应:
json
{
"code": 500,
"msg": "返回码含义说明",
"data": "具体错误信息描述"
}数据加密
Cookie 和 LocalStorage 数据在上传和下载时均需使用 AES-256-GCM 算法进行加密。加密密码为用户在插件设置中配置的同步密码。
| 项目 | 说明 |
|---|---|
| 算法 | AES-256-GCM |
| 密钥派生 | PBKDF2(SHA-256,100000 次迭代) |
| 盐值 | cookie-plus-salt-v1 |
| IV 长度 | 12 字节(随机生成) |
| 密文格式 | Base64(IV + Ciphertext + AuthTag) |
详细的加密说明和多语言代码示例请参考 数据加密。
接口分类
授权令牌
通过密钥获取授权令牌,用于后续接口调用的身份认证。
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 获取授权令牌 | POST | /api/common/openApi/getAccessKey | 获取 API 授权令牌 |
域名管理
管理监控域名的增删查操作,包括设置上传客户端等。
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 域名列表 | GET | /open/domainData/domainList | 获取所有监控域名 |
| 新增域名 | POST | /open/domainData/addDomain | 添加新的监控域名 |
| 删除域名 | GET | /open/domainData/deleteDomain | 删除监控域名 |
| 设置上传客户端 | POST | /open/domainData/setUploadClient | 设置域名的上传客户端 |
| 获取上传客户端 | GET | /open/domainData/uploadClient | 获取域名的上传客户端设备 ID |
Cookie 数据
Cookie 数据的上传和下载。
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 上传 Cookie | POST | /open/cookieData/upload | 上传指定域名的 Cookie 数据 |
| 下载 Cookie | GET | /open/cookieData/download | 下载指定域名的 Cookie 数据 |
LocalStorage 数据
LocalStorage 数据的上传和下载。
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 上传 LocalStorage | POST | /open/localStorageData/upload | 上传指定域名的 LocalStorage 数据 |
| 下载 LocalStorage | GET | /open/localStorageData/download | 下载指定域名的 LocalStorage 数据 |
身份管理
管理用户身份,实现多身份下的数据隔离。
| 接口 | 方法 | 路径 | 说明 |
|---|---|---|---|
| 身份列表 | GET | /open/userIdentity/list | 获取用户所有身份 |
| 新建身份 | POST | /open/userIdentity/create | 创建新的用户身份 |
| 修改身份 | POST | /open/userIdentity/update | 修改已有身份信息 |
| 删除身份 | GET | /open/userIdentity/delete | 删除用户身份 |
