OpenAPI YAMLOpenAPI JSONproblemas YAMLResumen de la API
Este grupo tiene 6 operaciones, generadas a partir de api/openapi.yaml. Filtre por ruta, acción o autenticación. Cada endpoint indica sus entradas; despliéguelo para ver una plantilla de solicitud y los códigos de respuesta. Las plantillas necesitan sus propios valores y un cuerpo válido según el esquema.
Reemplace los marcadores en mayúsculas con sus valores. Para una solicitud JSON, guarde un cuerpo que coincida con el esquema en request.json. Los ejemplos de cookies usan un frasco de cookies local de una sesión autenticada.
Transferencia del navegador de la página principal
Reclamar enlace del navegador
Reclama un código de enlace de navegador para el proyecto autenticado y crea atómicamente exactamente una pantalla first pairing_pending más su concesión de aprovisionamiento de navegador existente. La inscripción sigue siendo solo para el proyecto. La respuesta es solo metadatos seguros y nunca contiene un token de aprovisionamiento, URL fragmentada, cookie o prueba.
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| ScreenRig-Project | encabezado | opcional | Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token. |
| Idempotency-Key | encabezado | requerido |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| código (requerido, cadena) | patrón: "^[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}-?[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}$" |
Plantilla y respuestas de solicitud
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'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 201 | Reclamación exacta de enlace de navegador sin fragmentos y segura para reproducción. | BrowserLinkClaim (application/json); encabezados: Cache-Control, RateLimit-Policy, RateLimit |
| 400 | Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | Problema (application/problem+json) |
| 403 | Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | Problema (application/problem+json) |
| 404 | Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | Problema (application/problem+json) |
| 409 | Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | Problema (application/problem+json) |
| 410 | Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | Problema (application/problem+json) |
| 429 | Problema estable rate_limited. Reintente solo después del intervalo Retry-After autorizado. Las denegaciones de ventana fija también incluyen la política RateLimit-Policy y los miembros RateLimit aplicables; las denegaciones por concurrencia y presupuesto de bytes omiten esas divulgaciones opcionales. | Problema (application/problem+json); encabezados: Retry-After, RateLimit-Policy, RateLimit |
| 500 | Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | Problema (application/problem+json) |
| predeterminado | Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | Problema (application/problem+json) |
Obtener estado de enlace de navegador
Lectura solo con autenticación por cookie apex browser-link propietaria. Devuelve metadatos de estado seguros y la ruta fija de continuación, nunca URL o token de aprovisionamiento.
Plantilla y respuestas de solicitud
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | Estado seguro reclamado. | BrowserLinkStatus (application/json); encabezados: Cache-Control, Referrer-Policy |
| 202 | El enlace del navegador existe pero aún no ha sido reclamado. | BrowserLinkStatus (application/json); encabezados: Cache-Control, Referrer-Policy |
| 401 | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
| 410 | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
| predeterminado | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
Iniciar enlace de navegador
POST estrictamente del mismo origen sin JavaScript compatible que crea o reutiliza una sesión de enlace de navegador no reclamada de 24 horas. Reclamar dentro de esa ventana crea una nueva ventana protegida de aprovisionamiento y entrega de diez minutos; el emparejamiento de Player con cookie dura 24 horas.
La vinculación nativa es un localizador no reclamado separado de setenta y dos horas; la entrega nativa reclamada permanece duradera hasta la finalización firmada o el reinicio explícito en el reproductor. Establece exactamente la cookie apex host-only Secure HttpOnly SameSite=Strict Path=/ __Host-screenrig-browser-link sin Domain.
Los clientes JSON reciben 201; Accept text/html recibe un 303 sin cuerpo a /setup. No existe fallback inseguro localhost; el desarrollo requiere el origen HTTPS loopback configurado.
Plantilla y respuestas de solicitud
curl --request POST 'https://screenrig.ai/screen/browser-links'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 201 | Metadatos seguros del código/estado del enlace del navegador. | BrowserLinkSession (application/json); encabezados: Cache-Control, Referrer-Policy, Set-Cookie, RateLimit-Policy, RateLimit |
| 303 | Continuación del formulario No-JavaScript a la página de configuración de solo lectura. | sin cuerpo; encabezados: Location, Cache-Control, Referrer-Policy, Set-Cookie |
| 403 | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
| 409 | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
| 429 | Problema estable rate_limited en una ruta de ejecución o contenido orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Reintente solo después del intervalo Retry-After autorizado. Las denegaciones de ventana fija también incluyen la política RateLimit-Policy y los miembros RateLimit aplicables; las denegaciones por concurrencia y presupuesto de bytes omiten esas divulgaciones opcionales. | RuntimeProblem (application/problem+json); encabezados: Retry-After, RateLimit-Policy, RateLimit |
| 500 | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
| predeterminado | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
Transmitir eventos de enlace de navegador
Reproducción SSE reproducible solo con cookie de propietario y Last-Event-ID. Los datos del evento contienen solo campos de estado seguros. Nunca contiene una URL/token de aprovisionamiento y no usa el flujo de eventos del proyecto.
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| Last-Event-ID | encabezado | opcional | Cursor duradero usado cuando after está ausente. |
Plantilla y respuestas de solicitud
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/stream/browser-links/events'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | Estado SSE de emisión/reclamación de Browser-link. | cadena (text/event-stream); encabezados: Cache-Control, Referrer-Policy, X-Accel-Buffering |
| 400 | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
| 401 | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
| 410 | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
| predeterminado | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
Continuar enlace del navegador
GET autenticado solo con cookie de propietario para navegación. Tras la reclamación devuelve un 303 sin cuerpo cuya Location sensible es la URL exacta Player /s/<public_id>#provision=<token>. La Location nunca se expone mediante CORS, JSON, SSE, sondeo, registros, trazas, métricas, análisis, eventos o errores y es idempotente solo durante la breve ventana de reparación de entrega.
Plantilla y respuestas de solicitud
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links/continue'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 303 | Redirección sin cuerpo al fragmento de aprovisionamiento del Player. | sin cuerpo; encabezados: Location, Cache-Control, Referrer-Policy |
| 401 | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
| 409 | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
| 410 | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
| predeterminado | Respuesta estable RFC 9457 a problemas en una ruta de ejecución, contenido o sonda orientada al reproductor, en la forma del documento de ejecución (RuntimeProblem). Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | RuntimeProblem (application/problem+json) |
Obtener página de configuración de enlace de navegador
Instrucciones de configuración solo lectura. Sin código, la cookie browser-link propietaria suministra estado. Con código, devuelve instrucciones públicas, usando 404 genérico para códigos inválidos o expirados. Acepta text/markdown o format=markdown para seleccionar Markdown en el formulario público. No devuelve URL ni token de aprovisionamiento.
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| código | consulta | opcional | Código de configuración pública para instrucciones de configuración sin efectos secundarios; no se requiere cookie. |
| formato | consulta | opcional |
Plantilla y respuestas de solicitud
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/setup'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | Configuración segura noindex HTML. | cadena (text/html); encabezados: Cache-Control, Referrer-Policy, X-Robots-Tag |
| 401 | Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | Problema (application/problem+json) |
| 410 | Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | Problema (application/problem+json) |
| predeterminado | Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico. | Problema (application/problem+json) |