API
L’API di OpenReplay ti permette di gestire i dati degli utenti ed esportare gli eventi acquisiti per l’analisi esterna.
URL di base (v2 - Attuale)
Section titled URL di base (v2 - Attuale)Usa l’URL di base dell’API pubblica v2 per tutte le nuove integrazioni. Tutti gli endpoint si autenticano tramite la chiave API dell’organizzazione. Ogni route ha il prefisso /public.
- Cloud Serverless:
https://api.openreplay.com/v2 - Cloud Dedicated / self-hosted:
https://YOUR_INSTANCE_DOMAIN/v2/api
In tutta la documentazione che segue, {BASE_URL} indica l’URL di base applicabile alla tua distribuzione.
Autenticazione
Section titled AutenticazioneTutti gli endpoint dell’API pubblica v2 sono autenticati con la chiave API dell’organizzazione (disponibile in ‘Preferences’ > ‘Account’ > ‘Organization API Key’), inviata come Bearer token:
Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}
Le risposte di successo sono in formato JSON e racchiuse in { "data": ... }. Gli errori vengono restituiti come { "error": "<message>" } con il codice di stato HTTP appropriato (400, 401, 404, 409, 500, …).
URL di base (v1 - Obsoleto)
Section titled URL di base (v1 - Obsoleto)Gli endpoint v1 riportati di seguito restano disponibili per retrocompatibilità, ma sono obsoleti. Passa agli endpoint v2.
- Per il piano Cloud Serverless:
https://api.openreplay.com/api/v1 - Per le istanze Cloud Dedicated o self-hosted open source:
https://YOUR_INSTANCE_DOMAIN/api/