API
OpenReplay API 允许您管理用户数据并导出捕获的事件以供外部分析。
基础 URL(v2 - 当前版本)
Section titled 基础 URL(v2 - 当前版本)请在所有新集成中使用 v2 公共 API 基础 URL。所有端点均通过组织 API 密钥进行身份验证。每个路由都以 /public 为前缀。
- Cloud Serverless:
https://api.openreplay.com/v2 - Cloud Dedicated / 自托管:
https://YOUR_INSTANCE_DOMAIN/api/v2
在下文的整个文档中,{BASE_URL} 指代适用于您部署环境的相应基础 URL。
所有 v2 公共 API 端点都使用组织 API 密钥(位于 ‘Preferences’ > ‘Account’ > ‘Organization API Key’)进行身份验证,并以 Bearer 令牌的形式发送:
Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}
成功的响应为 JSON 格式,并封装在 { "data": ... } 中。错误以 { "error": "<message>" } 的形式返回,并附带相应的 HTTP 状态码(400、401、404、409、500、…)。
基础 URL(v1 - 已弃用)
Section titled 基础 URL(v1 - 已弃用)下面的 v1 端点为保持向后兼容仍然可用,但已弃用。请迁移到 v2 端点。
- 对于 Cloud Serverless 套餐:
https://api.openreplay.com/api/v1 - 对于 Cloud Dedicated 或开源自托管实例:
https://YOUR_INSTANCE_DOMAIN/api/