OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Überblick
Diese Gruppe hat 7 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.
Website-Demoanfragen und Buchungen
Website-Demo-Anfrage absenden
Same-Origin-anonyme Website-Aufnahme. Speichert die Anfrage und unabhängige Zustelljobs vor der Klassifizierung. Idempotency-Key ist eine unabhängig zufällige private Wiederholungs-UUID, die nur im Browser-Speicher verbleibt. Es ist nicht die öffentliche flow_id. Übereinstimmende Wiederholungen setzen dasselbe HttpOnly-screenrig_demo-Cookie und geben die gespeicherte Anfrage ohne erneute Übermittlung zurück.
Anfragen und Antworten sind vom Payload-Logging ausgeschlossen. Das Land wählt keine Zeitzone aus. Es wird keine Projekt- oder Dashboard-Anmeldung erstellt.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| Herkunft | Überschrift | erforderlich | Same-origin Browser-Anfrage; konfigurierte Stage-Origin wird auf Stage akzeptiert. |
| Idempotency-Key | Überschrift | erforderlich | |
| f | Abfrage | optional | Nicht-geheimer Funnel-Versuchs-ID, identisch mit body flow_id. |
| src | Abfrage | optional | Freigegebene Quelle, identisch mit der Quelle im Body. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| E-Mail (erforderlich, Zeichenfolge) | maxLength: 254 Format: "email" |
| country (erforderlich, Zeichenfolge) | ISO 3166-1 Ländercode; separat von der Zeitzone gespeichert. Muster: "^[A-Z]{2}$" |
| screen_range (erforderlich, Zeichenkette) | Erlaubt: "1_10", "11_50", "51_250", "251_plus", "unknown" |
| Organisation (erforderlich, String) | Erlaubt: "small_mid", "large_corporation", "agency_network" |
| Budget (erforderlich, Zeichenfolge) | Selbstberichtetes jährliches Beschilderungsbudget in USD. Erlaubt: "under_2995", "2995_19994", "19995_plus", "unknown" |
| Zeitzone (erforderlich, Zeichenkette) | IANA-Zeitzone oder leer, wenn Browsererkennung nicht verfügbar ist; Zeitplanung erfordert explizite Zeitzone. maxLength: 100 |
| source (erforderlich, DemoSource) | Erlaubt: "home_hero", "home_paid_plans", "pricing_plus", "pricing_education", "pricing_premium", "pricing_enterprise", "resellers", "direct" |
| flow_id (erforderlich, Zeichenkette) | Zufällige nicht geheime Analyseversuchs-ID, niemals Autorisierung. Muster: "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" |
Anfragevorlage und Antworten
curl --request POST --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-requests'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Anfrage dauerhaft gespeichert. Setzt privates Demo-Sitzungscookie. | DemoResult (application/json) |
| 200 | Idempotente Wiedergabe der gespeicherten Anfrage. | DemoResult (application/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) |
Website-Demo-Anfrage erhalten
Cookie-gebundene gespeicherte Anfrage. Eine Anfrage-ID oder öffentliche Flow-ID gewährt keinen Zugriff. Kein Speicher.
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-request'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Gespeicherte Demo-Anfrage und Buchungsstatus. | DemoResult (application/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) |
Website-Demo-Kalender erhalten
Privater Kalender-Download für die bestätigte Buchung dieses Browsers. Überprüft das gespeicherte Ereignis erneut; keine Anfrage-ID oder öffentlicher Flow-ID gewährt Zugriff. Kein Speichern.
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-calendar'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Importierbares Kalenderereignis mit stabiler Identität und bestätigten Zeiten. | string (text/calendar) |
| 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) |
Website-Demo-Zeiträume erhalten
Bis zu vier tatsächlich verfügbare 30-Minuten-Slots, möglichst über verschiedene Daten und Zeiten verteilt, in der vom Besucher bearbeitbaren IANA-Zeitzone. Private Slot-IDs werden im JSON-Body zurückgegeben und nie in URL-Abfragen gesendet. Nicht konfigrierter Kalender oder keine vernünftige Zeitzonenüberschneidung liefert eine leere Liste.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| Zeitzone | Abfrage | erforderlich | |
| aktualisieren | Abfrage | optional | Alternativen zum vorherigen cookie-gebundenen Batch anbieten. |
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-slots?timezone=TIMEZONE'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Echte verfügbare Slots oder eine leere Liste. | DemoSlots (application/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) |
Website-Demo buchen
Überprüft einen cookie-gebundenen Slot, reserviert atomar Host-Pufferzellen und erstellt ein stabiles Ereignis im konfigurierten lokalen oder Google-Kalender. Bestätigung erfordert das reale Ereignis und die gespeicherte Buchung. Mehrdeutige Anbieterfehler bleiben ausstehend für dauerhafte Abgleichung, ohne zweites Ereignis oder falsch gebuchte Seite.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| Herkunft | Überschrift | erforderlich | Same-origin Browser-Anfrage; konfigurierte Stage-Origin wird auf Stage akzeptiert. |
| f | Abfrage | optional | Nicht-geheimer Funnel-Versuchs-ID, identisch mit der gespeicherten flow_id. |
| src | Abfrage | optional | Gespeicherte erlaubte Quelle. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| slot_id (erforderlich, Zeichenfolge) | Nur leer für die Wiedergabe einer bereits bestätigten, cookie-gebundenen Buchung. Muster: "^([A-Za-z0-9_-]{20,128})?$" |
| Zeitzone (erforderlich, Zeichenkette) | maxLength: 100 |
Anfragevorlage und Antworten
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-bookings'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Kalendereintrag und Buchung bestätigt und gespeichert. | DemoResult (application/json) |
| 200 | Bereits bestätigte Buchungswiederholung. | DemoResult (application/json) |
| 202 | Buchung ausstehend bei Anbieterabstimmung; von bestätigten Buchungsanalysen ausgeschlossen. | DemoResult (application/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) |
| 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) |
Website-Demobewertung anfordern
Markiert die bestehende On-Demand-Anfrage zur Teamüberprüfung ohne weiteren Fragebogen. Späte Klassifizierer-Antworten können diese Wahl nicht rückgängig machen.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| Herkunft | Überschrift | erforderlich | Same-origin Browser-Anfrage; konfigurierte Stage-Origin wird auf Stage akzeptiert. |
Anfragevorlage und Antworten
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-review'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Aktuelle gespeicherte Anfrage mit angeforderter Prüfung. | DemoResult (application/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) |
Website-Demo-Einladung austauschen
Tauscht eine per E-Mail versandte siebentägige Buchungseinladung gegen eine nur im Browser verfügbare HttpOnly-Demo-Sitzung ein. Die Website entfernt ihr Einladungsfragment vor jeder Anfrage und sendet das Token nur in diesem privaten POST-Body, niemals in einer URL, Weiterleitung, Analyse-Markierung oder Protokoll. Mehrere Browsersitzungen können dieselbe einladungsgebundene Anfrage aufrufen.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| Herkunft | Überschrift | erforderlich | Same-origin Browser-Anfrage; konfigurierte Stage-Origin wird auf Stage akzeptiert. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Token (erforderlich, Zeichenkette) | Muster: "^[A-Za-z0-9_-]{20,128}$" |
Anfragevorlage und Antworten
curl --request POST --cookie-jar cookies.txt --header 'Origin: https://screenrig.ai' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/demo-session'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Cookie gesetzte und gespeicherte Demo-Anfrage zurückgegeben. | DemoResult (application/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) |