API
OpenReplay API를 사용하면 사용자 데이터를 관리하고 수집된 이벤트를 외부 분석용으로 내보낼 수 있습니다.
기본 URL (v2 - 현재)
Section titled 기본 URL (v2 - 현재)모든 새로운 통합에는 v2 공개 API 기본 URL을 사용하세요. 모든 엔드포인트는 Organization API Key로 인증하며, 모든 경로 앞에는 /public이 붙습니다.
- Cloud Serverless:
https://api.openreplay.com/v2 - Cloud Dedicated / 셀프 호스팅:
https://YOUR_INSTANCE_DOMAIN/v2/api
이후 문서에서 {BASE_URL}은 사용 중인 배포 환경에 해당하는 기본 URL을 의미합니다.
모든 v2 공개 API 엔드포인트는 Organization API Key(‘Preferences’ > ‘Account’ > ‘Organization API Key’에서 확인 가능)로 인증하며, 이 키를 Bearer 토큰으로 전송합니다.
Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}
성공 응답은 JSON이며 { "data": ... } 형태로 감싸져 있습니다. 오류는 적절한 HTTP 상태 코드(400, 401, 404, 409, 500, …)와 함께 { "error": "<message>" } 형태로 반환됩니다.
기본 URL (v1 - 지원 중단)
Section titled 기본 URL (v1 - 지원 중단)아래의 v1 엔드포인트는 하위 호환성을 위해 계속 제공되지만 지원이 중단(deprecated) 되었습니다. v2 엔드포인트로 마이그레이션하세요.
- Cloud Serverless 플랜:
https://api.openreplay.com/api/v1 - Cloud Dedicated 또는 오픈소스 셀프 호스팅 인스턴스:
https://YOUR_INSTANCE_DOMAIN/api/