OpenAPI YAMLOpenAPI JSONproblemi YAMLPanoramica dell’API
Questo gruppo ha 6 operazioni, generate da api/openapi.yaml. Filtra per percorso, azione o autenticazione. Ogni endpoint elenca i suoi input; espandilo per vedere un modello di richiesta e i codici di risposta. I modelli richiedono i tuoi valori e un corpo valido secondo lo schema.
Sostituisci i segnaposto maiuscoli con i tuoi valori. Per una richiesta JSON, salva un corpo che corrisponde allo schema in request.json. Gli esempi di cookie usano un cookie jar locale da una sessione autenticata.
Passaggio browser homepage
Richiedi link browser
Richiede un codice link browser per il progetto autenticato e crea atomica esattamente uno schermo pairing_pending iniziale più la sua concessione di provisioning browser esistente. L’iscrizione resta solo progetto. La risposta è solo metadati sicuri e non contiene mai token di provisioning, URL frammento, cookie o prova.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| Idempotency-Key | intestazione | obbligatorio |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| codice (obbligatorio, stringa) | pattern: "^[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}-?[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}$" |
Modello richiesta e risposte
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/project/browser-links/claim'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 201 | Dichiarazione di collegamento browser senza frammenti e sicura per la riproduzione esatta. | BrowserLinkClaim (application/json); intestazioni: Cache-Control, RateLimit-Policy, RateLimit |
| 400 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 403 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 404 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 409 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 410 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 429 | Problema rate_limited stabile. Ritenta solo dopo l'intervallo Retry-After autorevole. I dinieghi a finestra fissa includono anche RateLimit-Policy e membri RateLimit applicabili; i dinieghi per concorrenza e budget byte omettono tali divulgazioni opzionali. | Problema (application/problem+json); intestazioni: Retry-After, RateLimit-Policy, RateLimit |
| 500 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Ottieni stato Browser Link
Solo lettura fallback di polling autenticato solo dal cookie apex browser-link proprietario. Restituisce metadati di stato sicuri e il percorso di continuazione fisso, mai un URL o token di provisioning.
Modello richiesta e risposte
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Stato sicuro richiesto. | BrowserLinkStatus (application/json); intestazioni: Cache-Control, Referrer-Policy |
| 202 | Link browser esiste ma non è ancora stato reclamato. | BrowserLinkStatus (application/json); intestazioni: Cache-Control, Referrer-Policy |
| 401 | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
| 410 | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
Avvia collegamento browser
POST rigoroso no-JavaScript stessa origine che crea o riusa una sessione link browser non reclamata di 24 ore. La rivendicazione in questa finestra crea una nuova finestra protetta di provisioning-consegna di dieci minuti; l’associazione Player cookie dura 24 ore.
L’associazione nativa è un localizzatore separato non reclamato di settantadue ore; la consegna nativa reclamata rimane duratura fino al completamento firmato o al reset esplicito sul lettore. Imposta esattamente il cookie apex host-only Secure HttpOnly SameSite=Strict Path=/ __Host-screenrig-browser-link senza Domain.
I client JSON ricevono 201; Accept text/html riceve un 303 senza corpo a /setup. Non esiste fallback localhost insicuro; lo sviluppo richiede l’origine loopback HTTPS configurata.
Modello richiesta e risposte
curl --request POST 'https://screenrig.ai/screen/browser-links'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 201 | Metadati sicuri del codice/stato del collegamento browser. | BrowserLinkSession (application/json); intestazioni: Cache-Control, Referrer-Policy, Set-Cookie, RateLimit-Policy, RateLimit |
| 303 | Continuazione del modulo No-JavaScript alla pagina di configurazione in sola lettura. | nessun corpo; intestazioni: Location, Cache-Control, Referrer-Policy, Set-Cookie |
| 403 | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
| 409 | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
| 429 | Problema rate_limited stabile su runtime o percorso contenuto rivolto al Player, nella forma documento runtime (RuntimeProblem). Ritenta solo dopo l'intervallo Retry-After autorevole. I dinieghi a finestra fissa includono anche RateLimit-Policy e membri RateLimit applicabili; i dinieghi per concorrenza e budget byte omettono tali divulgazioni opzionali. | RuntimeProblem (application/problem+json); intestazioni: Retry-After, RateLimit-Policy, RateLimit |
| 500 | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
Eventi link browser flusso
Replay SSE riproducibile solo con cookie di proprietà e Last-Event-ID. I dati evento contengono solo campi di stato sicuri. Non contiene mai URL/token di provisioning e non usa il flusso eventi del progetto.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| Last-Event-ID | intestazione | opzionale | Cursore durevole usato quando after è assente. |
Modello richiesta e risposte
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/stream/browser-links/events'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Stato di emissione/richiesta Browser-link SSE. | stringa (text/event-stream); intestazioni: Cache-Control, Referrer-Policy, X-Accel-Buffering |
| 400 | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
| 401 | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
| 410 | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
Continua link browser
GET autenticato solo da cookie di proprietà per navigazione. Dopo il reclamo restituisce un 303 senza corpo la cui Location sensibile è l’esatto URL Player /s/<public_id>#provision=<token>. La Location non è mai esposta tramite CORS, JSON, SSE, polling, log, tracce, metriche, analytics, eventi o errori ed è idempotente solo durante la breve finestra di riparazione consegna.
Modello richiesta e risposte
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links/continue'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 303 | Reindirizzamento senza corpo al frammento di provisioning Player. | nessun corpo; intestazioni: Location, Cache-Control, Referrer-Policy |
| 401 | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
| 409 | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
| 410 | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | RuntimeProblem (application/problem+json) |
Ottieni pagina configurazione Browser Link
Istruzioni di configurazione in sola lettura. Senza codice, il cookie browser-link proprietario fornisce lo stato. Con codice, restituisce istruzioni solo pubbliche, usando 404 generico per codici invalidi o scaduti. Accetta text/markdown o format=markdown seleziona Markdown per il modulo codice pubblico. Non restituisce URL o token di provisioning.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| codice | query | opzionale | Codice di configurazione pubblico per istruzioni di configurazione senza effetti collaterali; non è richiesto alcun cookie. |
| formato | query | opzionale |
Modello richiesta e risposte
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/setup'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | HTML di configurazione noindex sicuro. | stringa (text/html); intestazioni: Cache-Control, Referrer-Policy, X-Robots-Tag |
| 401 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 410 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |