OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Überblick
Diese Gruppe hat 6 Operationen, generiert aus api/openapi.yaml. Filtern Sie nach Pfad, Aktion oder Authentifizierung. Jeder Endpunkt listet seine Eingaben auf; klappen Sie ihn auf, um eine Anfragevorlage und die Antwortcodes zu sehen. Die Vorlagen brauchen Ihre eigenen Werte und einen schemagültigen Anfragekörper.
Großgeschriebene Platzhalter durch Ihre Werte ersetzen. Für eine JSON-Anfrage speichern Sie einen Body, der dem Schema in request.json entspricht. Cookie-Beispiele verwenden ein lokales Cookie-Archiv aus einer authentifizierten Sitzung.
Übergabe des Homepage-Browsers
Browser-Link beanspruchen
Beansprucht einen Browser-Link-Code für das authentifizierte Projekt und erstellt atomar genau einen ersten pairing_pending Bildschirm plus dessen bestehenden Browser-Berechtigungsnachweis. Die Anmeldung bleibt projektbezogen. Die Antwort enthält nur sichere Metadaten und niemals einen Bereitstellungstoken, Fragment-URL, Cookie oder Nachweis.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| ScreenRig-Project | Überschrift | optional | Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch. |
| Idempotency-Key | Überschrift | erforderlich |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Code (erforderlich, Zeichenfolge) | Muster: "^[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}-?[23456789ABCDEFGHJKMNPQRSTUVWXYZ]{3}$" |
Anfragevorlage und Antworten
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'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Exakte wiedergabesichere fragmentfreie Browser-Link-Anspruch. | BrowserLinkClaim (application/json); Header: Cache-Control, RateLimit-Policy, RateLimit |
| 400 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 403 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 404 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 409 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 410 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 429 | Stabiles rate_limited-Problem. Nur nach dem autoritativen Retry-After-Intervall erneut versuchen. Ablehnungen mit festem Fenster enthalten auch die anwendbare RateLimit-Policy und RateLimit-Mitglieder; Ablehnungen wegen gleichzeitiger Nutzung und Byte-Budget enthalten diese optionalen Angaben nicht. | Problem (application/problem+json); Header: Retry-After, RateLimit-Policy, RateLimit |
| 500 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Browser-Link-Status abrufen
Nur lesendes Polling-Fallback, authentifiziert nur durch das zugehörige Apex-Browser-Link-Cookie. Es liefert sichere Status-Metadaten und den festen Fortsetzungspfad, niemals eine Bereitstellungs-URL oder einen Token.
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Sicherer Status beansprucht. | BrowserLinkStatus (application/json); Header: Cache-Control, Referrer-Policy |
| 202 | Browser-Link existiert, wurde aber noch nicht beansprucht. | BrowserLinkStatus (application/json); Header: Cache-Control, Referrer-Policy |
| 401 | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
| 410 | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
Browser-Link starten
Streng gleiche Herkunft, kein JavaScript-kompatibler POST, der eine 24-Stunden-unbeanspruchte Browser-Link-Sitzung erstellt oder wiederverwendet. Innerhalb dieses Zeitfensters erzeugt das Beanspruchen ein neues, unabhängiges zehnminütiges geschütztes Bereitstellungs-Lieferfenster; Cookie-Player-Kopplung dauert 24 Stunden.
Native Kopplung ist ein separater, siebzigstündiger, nicht beanspruchter Locator; beanspruchte native Zustellung bleibt dauerhaft bis zum unterschriebenen Abschluss oder expliziten Zurücksetzen am Player. Es setzt genau das apex host-only Secure HttpOnly SameSite=Strict Path=/ __Host-screenrig-browser-link Cookie ohne Domain.
JSON-Clients erhalten 201; Accept text/html erhält einen leeren 303 zu /setup. Kein unsicherer localhost-Fallback vorhanden; Entwicklung erfordert den konfigurierten HTTPS-Loopback-Ursprung.
Anfragevorlage und Antworten
curl --request POST 'https://screenrig.ai/screen/browser-links'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Sichere Browser-Link-Code-/Status-Metadaten. | BrowserLinkSession (application/json); Header: Cache-Control, Referrer-Policy, Set-Cookie, RateLimit-Policy, RateLimit |
| 303 | No-JavaScript Formularfortsetzung zur schreibgeschützten Setup-Seite. | kein Körper; Header: Location, Cache-Control, Referrer-Policy, Set-Cookie |
| 403 | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
| 409 | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
| 429 | Stabiles rate_limited-Problem bei einer Player-gerichteten Laufzeit- oder Inhaltsroute im Laufzeit-Dokumentformat (RuntimeProblem). Nur nach dem autoritativen Retry-After-Intervall erneut versuchen. Ablehnungen mit festem Fenster enthalten auch die anwendbare RateLimit-Policy und RateLimit-Mitglieder; Ablehnungen wegen gleichzeitiger Nutzung und Byte-Budget enthalten diese optionalen Angaben nicht. | RuntimeProblem (application/problem+json); Header: Retry-After, RateLimit-Policy, RateLimit |
| 500 | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
Stream Browser-Link-Ereignisse
Nur mit Eigentümer-Cookie wiederholbares SSE mit Last-Event-ID. Ereignisdaten enthalten nur sichere Statusfelder. Es enthält niemals eine Bereitstellungs-URL/-Token und verwendet nicht den Projekt-Ereignisstrom.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| Last-Event-ID | Überschrift | optional | Dauerhafter Cursor, der verwendet wird, wenn after fehlt. |
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/stream/browser-links/events'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Status SSE für ausgegebene/beanspruchte Browser-Links. | string (text/event-stream); Header: Cache-Control, Referrer-Policy, X-Accel-Buffering |
| 400 | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
| 401 | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
| 410 | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
Browser-Link fortsetzen
Nur Navigation, cookie-authentifizierter GET. Nach der Beanspruchung gibt es einen körperlosen 303 zurück, dessen sensitiver Location-Header die exakte Player-URL /s/<public_id>#provision=<token> ist. Die Location wird niemals über CORS, JSON, SSE, Polling, Logs, Traces, Metriken, Analytics, Ereignisse oder Fehler offengelegt und ist nur während des kurzen Lieferreparaturfensters idempotent.
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/screen/browser-links/continue'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 303 | Weiterleitung ohne Textkörper zum Player-Provisioning-Fragment. | kein Körper; Header: Location, Cache-Control, Referrer-Policy |
| 401 | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
| 409 | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
| 410 | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort bei einer Player-gerichteten Laufzeit-, Inhalts- oder Probe-Route im Laufzeit-Dokumentformat (RuntimeProblem). Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | RuntimeProblem (application/problem+json) |
Browser-Link-Einrichtungsseite abrufen
Nur lesende Einrichtungshinweise. Ohne Code liefert das zugehörige Browser-Link-Cookie den Status. Mit Code werden nur öffentliche Anweisungen zurückgegeben, bei ungültigen oder abgelaufenen Codes generisches 404. Akzeptiert text/markdown oder format=markdown wählt Markdown für das öffentliche Codeformular. Keine Bereitstellungs-URL oder Token wird zurückgegeben.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| Code | Abfrage | optional | Öffentlicher Einrichtungscode für nebenwirkungsfreie Einrichtungshinweise; kein Cookie erforderlich. |
| Format | Abfrage | optional |
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/setup'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Sicheres Noindex-Setup-HTML. | string (text/html); Header: Cache-Control, Referrer-Policy, X-Robots-Tag |
| 401 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 410 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |