API
La API de OpenReplay le permite gestionar datos de usuario y exportar eventos capturados para su análisis externo.
URL base (v2 - Actual)
Section titled URL base (v2 - Actual)Utilice la URL base de la API pública v2 para todas las integraciones nuevas. Todos los endpoints se autentican mediante la clave API de la organización. Cada ruta lleva el prefijo /public.
- Cloud Serverless:
https://api.openreplay.com/v2 - Cloud Dedicated / autoalojado:
https://YOUR_INSTANCE_DOMAIN/api/v2
A lo largo de la documentación que aparece a continuación, {BASE_URL} hace referencia a la URL base que corresponda a su implementación.
Autenticación
Section titled AutenticaciónTodos los endpoints de la API pública v2 se autentican con la clave API de la organización (que se encuentra en ‘Preferences’ > ‘Account’ > ‘Organization API Key’) enviada como token Bearer:
Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}
Las respuestas correctas se devuelven en JSON y se envuelven en { "data": ... }. Los errores se devuelven como { "error": "<message>" } con el código de estado HTTP correspondiente (400, 401, 404, 409, 500, …).
URL base (v1 - Obsoleta)
Section titled URL base (v1 - Obsoleta)Los endpoints v1 que se indican a continuación siguen estando disponibles por motivos de compatibilidad con versiones anteriores, pero están obsoletos. Migre a los endpoints v2.
- Para el plan Cloud Serverless:
https://api.openreplay.com/api/v1 - Para instancias Cloud Dedicated o de código abierto autoalojadas:
https://YOUR_INSTANCE_DOMAIN/api/