102 lines
2.5 KiB
Markdown
102 lines
2.5 KiB
Markdown
# OpenInstall API 测试结果
|
|
|
|
## 测试总结
|
|
|
|
✅ **成功连接到 OpenInstall API**
|
|
|
|
- API 基础 URL: `https://data.openinstall.com`
|
|
- 测试的接口端点工作正常
|
|
- HTTP 状态码: 200
|
|
|
|
## 当前问题
|
|
|
|
❌ **ApiKey 配置错误**
|
|
|
|
API 返回错误: `code=3, error="apiKey错误"`
|
|
|
|
## 问题分析
|
|
|
|
当前配置中:
|
|
- `AppKey: alf57p` - 这是应用的标识符(AppKey),用于 SDK 集成
|
|
- 但数据接口需要的是单独的 `apiKey`,这两者不同
|
|
|
|
## 解决方案
|
|
|
|
### 步骤 1: 在 OpenInstall 后台配置数据接口
|
|
|
|
1. 登录 OpenInstall 后台: https://www.openinstall.com
|
|
2. 找到 **【数据接口】-【接口配置】** 菜单
|
|
3. **开启数据接口开关**
|
|
4. 获取 `apiKey` (这是专门用于数据接口的密钥,不同于 AppKey)
|
|
|
|
### 步骤 2: 更新配置文件
|
|
|
|
在 `ppanel-server/etc/ppanel.yaml` 中添加 `ApiKey`:
|
|
|
|
```yaml
|
|
OpenInstall:
|
|
Enable: true
|
|
AppKey: "alf57p" # SDK 集成使用
|
|
ApiKey: "your_api_key_from_backend" # 数据接口使用
|
|
```
|
|
|
|
### 步骤 3: 重新测试
|
|
|
|
获取到正确的 apiKey 后,运行测试程序:
|
|
|
|
```bash
|
|
cd cmd/test_openinstall
|
|
go run main.go
|
|
```
|
|
|
|
## 测试接口说明
|
|
|
|
测试程序当前测试了以下接口:
|
|
|
|
### 1. 新增安装数据 (Growth Data)
|
|
- 端点: `/data/event/growth`
|
|
- 功能: 获取指定时间范围内的访问量、点击量、安装量、注册量及留存数据
|
|
- 参数:
|
|
- `apiKey`: 数据接口密钥
|
|
- `startDate`: 开始日期 (格式: 2006-01-02)
|
|
- `endDate`: 结束日期
|
|
- `statType`: 统计类型 (daily=按天, hourly=按小时, total=合计)
|
|
|
|
返回数据包括:
|
|
- `visit`: 访问量
|
|
- `click`: 点击量
|
|
- `install`: 安装量
|
|
- `register`: 注册量
|
|
- `survive_d1`: 1日留存
|
|
- `survive_d7`: 7日留存
|
|
- `survive_d30`: 30日留存
|
|
|
|
### 2. 渠道列表 (Channel List)
|
|
- 端点: `/data/channel/list`
|
|
- 功能: 获取 H5 渠道列表
|
|
- 参数:
|
|
- `apiKey`: 数据接口密钥
|
|
- `pageNum`: 页码
|
|
- `pageSize`: 每页数量
|
|
|
|
## 更多可用接口
|
|
|
|
OpenInstall 数据接口还提供以下功能:
|
|
|
|
- 渠道分组管理 (创建、修改、删除)
|
|
- 渠道管理 (创建、修改、删除、查询)
|
|
- 子渠道管理
|
|
- 存量设备数据
|
|
- 活跃数据统计
|
|
- 效果点数据
|
|
- 设备分布统计
|
|
|
|
详细文档: https://www.openinstall.com/doc/data.html
|
|
|
|
## 下一步建议
|
|
|
|
1. **配置 ApiKey**: 按照上述步骤在 OpenInstall 后台获取并配置 apiKey
|
|
2. **更新配置**: 将 apiKey 添加到 `ppanel.yaml` 配置文件
|
|
3. **更新代码**: 修改 `pkg/openinstall/openinstall.go` 实现真实的 API 调用
|
|
4. **测试验证**: 重新运行测试程序验证数据获取
|