> For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt.

# 接入指引

## ROIBest 主流程示意图

![主流程示意图](/images/developer/img1.jpg)

## 更新日志

### Ver 1.3.1

Release date: 2024/02/08

#### 变更

| 功能     | 描述                                                    |
| :----- | :---------------------------------------------------- |
| 统一上报入口 | 将 kwai、tiktok、facebook 分别上报的功能合并至 /report/fb/event 接口 |

**注意**：原有使用 `/report/fb/event` API 的客户不受本次变更的影响，无需处理。

## API 使用说明

ROIBest 系统 API 均基于 HTTP 协议构建，API 的请求和响应要求使用 JSON 格式编码。在使用本 API 前你需要完成如下的前置动作：

1. 激活 ROIBest 账号，并创建一个应用
2. 在广告平台完成投放配置，并获取广告参数，如 token、pixle id 等
3. 将广告参数正确的配置到 ROIBest 系统后台

### API 认证方式

- [数据开放 API](/developer/open-api.md)：在请求头中携带 `X-Api-Key`，API Key 在后台「开放 API」页面生成。
- 其他 API：暂时无需认证。

### API 调用频率限制

- [数据开放 API](/developer/open-api.md)：每分钟最多 10 次请求。
- 其他 API：暂时无限制。

## API 列表

- [广告事件上报](/developer/event-report.md)
- [通过 link_id 查询落地页query参数](/developer/query-link-info.md)
- [查询安装成功事件](/developer/search-event.md)
- [数据开放 API：查询访问数与安装数](/developer/open-api.md)