OpenAPI YAMLOpenAPI JSONproblèmes YAMLVue d’ensemble de l’API
Ce groupe compte 6 opérations, générées à partir de api/openapi.yaml. Filtrez par chemin, action ou authentification. Chaque point de terminaison liste ses entrées ; développez-le pour voir un modèle de requête et les codes de réponse. Les modèles demandent vos propres valeurs et un corps conforme au schéma.
Remplacez les espaces réservés en majuscules par vos valeurs. Pour une requête JSON, enregistrez un corps correspondant au schéma dans request.json. Les exemples de cookies utilisent un pot à cookies local issu d’une session authentifiée.
Transfert du navigateur de la page d’accueil
Réclamer le lien du navigateur
Réclame un code de lien de navigateur pour le projet authentifié et crée atomiquement exactement un écran pairing_pending initial plus sa subvention de provisioning de navigateur existante. L’inscription reste limitée au projet. La réponse contient uniquement des métadonnées sûres et ne contient jamais de jeton de provisioning, URL fragmentée, cookie ou preuve.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
| Idempotency-Key | en-tête | obligatoire |
Champs du corps de la requête
| Champ | Description |
|---|---|
| code (obligatoire, chaîne) | modèle : "^[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}-?[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}$" |
Modèle de requête et réponses
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'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | Revendication de lien de navigateur sans fragment, sûre pour la relecture exacte. | BrowserLinkClaim (application/json) ; en-têtes : Cache-Control, RateLimit-Policy, RateLimit |
| 400 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 403 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 404 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 409 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 410 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 429 | Problème stable rate_limited. Réessayez seulement après l’intervalle Retry-After autoritaire. Les refus à fenêtre fixe incluent aussi la politique RateLimit-Policy applicable et les membres RateLimit ; les refus de concurrence et de budget d’octets omettent ces divulgations optionnelles. | Problème (application/problem+json) ; en-têtes : Retry-After, RateLimit-Policy, RateLimit |
| 500 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Obtenir le statut du lien du navigateur
Repli de sondage en lecture seule authentifié uniquement par le cookie apex browser-link propriétaire. Il retourne des métadonnées d’état sûres et le chemin de continuation fixe, jamais une URL ou un jeton de provisionnement.
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Statut sécurisé réclamé. | BrowserLinkStatus (application/json) ; en-têtes : Cache-Control, Referrer-Policy |
| 202 | Lien navigateur existant mais non encore revendiqué. | BrowserLinkStatus (application/json) ; en-têtes : Cache-Control, Referrer-Policy |
| 401 | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
| 410 | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
Démarrer lien navigateur
POST strictement même origine sans JavaScript compatible qui crée ou réutilise une session de lien de navigateur non réclamée de 24 heures. La réclamation dans cette fenêtre crée une nouvelle fenêtre protégée de provisionnement-livraison indépendante de dix minutes ; le jumelage Player par cookie dure 24 heures.
Le jumelage natif est un localisateur non réclamé distinct de soixante-douze heures ; la livraison native réclamée reste durable jusqu’à l’achèvement signé ou la réinitialisation explicite sur le lecteur. Il définit exactement le cookie apex host-only Secure HttpOnly SameSite=Strict Path=/ __Host-screenrig-browser-link sans domaine.
Les clients JSON reçoivent 201 ; Accept text/html reçoit un 303 sans corps vers /setup. Aucun repli localhost non sécurisé n'existe ; le développement nécessite l'origine HTTPS en boucle configurée.
Modèle de requête et réponses
curl --request POST 'https://screenrig.ai/screen/browser-links'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | Métadonnées sécurisées du code/statut de lien navigateur. | BrowserLinkSession (application/json) ; en-têtes : Cache-Control, Referrer-Policy, Set-Cookie, RateLimit-Policy, RateLimit |
| 303 | Continuation du formulaire No-JavaScript vers la page de configuration en lecture seule. | pas de corps; en-têtes : Location, Cache-Control, Referrer-Policy, Set-Cookie |
| 403 | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
| 409 | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
| 429 | Problème stable rate_limited sur un runtime ou une route de contenu face au lecteur, dans la forme du document runtime (RuntimeProblem). Réessayez seulement après l’intervalle Retry-After autoritaire. Les refus à fenêtre fixe incluent aussi la politique RateLimit-Policy applicable et les membres RateLimit ; les refus de concurrence et de budget d’octets omettent ces divulgations optionnelles. | Problème Runtime (application/problem+json) ; en-têtes : Retry-After, RateLimit-Policy, RateLimit |
| 500 | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
Événements de lien de navigateur en flux
Relecture SSE uniquement avec cookie propriétaire et Last-Event-ID. Les données d’événement contiennent uniquement des champs d’état sûrs. Elles ne contiennent jamais d’URL/token de provisionnement et n’utilisent pas le flux d’événements du projet.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| Last-Event-ID | en-tête | optionnel | Curseur durable utilisé quand after est absent. |
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/stream/browser-links/events'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Statut SSE émis/revendiqué du lien navigateur. | chaîne (text/event-stream); en-têtes : Cache-Control, Referrer-Policy, X-Accel-Buffering |
| 400 | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
| 401 | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
| 410 | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
Continuer le lien du navigateur
GET authentifié par cookie propriétaire en navigation seule. Après réclamation, il renvoie un 303 sans corps dont Location sensible est l’URL exacte Player /s/<public_id>#provision=<token>. La Location n’est jamais exposée via CORS, JSON, SSE, sondage, journaux, traces, métriques, analyses, événements ou erreurs et est idempotente uniquement durant la courte fenêtre de réparation de livraison.
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links/continue'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 303 | Redirection sans corps vers le fragment de provisioning du Player. | pas de corps; en-têtes : Location, Cache-Control, Referrer-Policy |
| 401 | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
| 409 | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
| 410 | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème sur un runtime, contenu ou route de sonde face au lecteur, dans la forme du document runtime (RuntimeProblem). Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème Runtime (application/problem+json) |
Obtenir la page de configuration du lien du navigateur
Instructions d’installation en lecture seule. Sans code, le cookie browser-link propriétaire fournit l’état. Avec code, retourne uniquement les instructions publiques, utilisant un 404 générique pour les codes invalides ou expirés. Accepte text/markdown ou format=markdown sélectionne Markdown pour le formulaire de code public. Aucune URL ou jeton de provisionnement n’est retourné.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| code | requête | optionnel | Code de configuration public pour des instructions d’installation sans effets secondaires ; aucun cookie requis. |
| format | requête | optionnel |
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/setup'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Configuration HTML noindex sécurisée. | chaîne (text/html); en-têtes : Cache-Control, Referrer-Policy, X-Robots-Tag |
| 401 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 410 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |