OpenAPI YAMLOpenAPI JSONproblèmes YAMLVue d’ensemble de l’API
Ce groupe compte 7 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.
Demandes et réservations de démonstration du site Web
Soumettre une demande de démonstration du site Web
Entrée anonyme de site Web même origine. Sauvegarde la requête et les tâches de livraison indépendantes avant classification. Idempotency-Key est un UUID privé de nouvelle tentative aléatoire indépendante, conservé uniquement en mémoire du navigateur. Ce n’est pas le flow_id public. Les nouvelles tentatives correspondantes définissent le même cookie HttpOnly screenrig_demo et renvoient la requête sauvegardée sans autre soumission.
Les requêtes et réponses sont exclues de la journalisation des charges utiles. Le pays ne sélectionne pas de fuseau horaire. Aucun projet ni connexion au tableau de bord n’est créé.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| Origine | en-tête | obligatoire | Requête navigateur même origine ; l’origine de scène configurée est acceptée sur scène. |
| Idempotency-Key | en-tête | obligatoire | |
| f | requête | optionnel | ID de tentative de tunnel non secret, identique à flow_id dans le corps. |
| src | requête | optionnel | Source autorisée, identique à la source du corps. |
Champs du corps de la requête
| Champ | Description |
|---|---|
| courriel (requis, chaîne) | maxLength : 254 format : « courriel » |
| country (obligatoire, chaîne) | Code pays ISO 3166-1 ; conservé séparément du fuseau horaire. motif : "^[A-Z]{2}$" |
| screen_range (obligatoire, chaîne) | Autorisés : « 1_10 », « 11_50 », « 51_250 », « 251_plus », « unknown » |
| organisation (obligatoire, chaîne) | Autorisé : « small_mid », « large_corporation », « agency_network » |
| budget (obligatoire, chaîne) | Budget annuel d’affichage auto-déclaré en USD. Autorisé : « under_2995 », « 2995_19994 », « 19995_plus », « unknown » |
| fuseau horaire (obligatoire, chaîne) | Fuseau horaire IANA, ou vide lorsque la détection du navigateur est indisponible ; la programmation nécessite un fuseau horaire explicite. maxLength : 100 |
| source (obligatoire, DemoSource) | Autorisés : « home_hero », « home_paid_plans », « pricing_plus », « pricing_education », « pricing_premium », « pricing_enterprise », « resellers », « direct » |
| flow_id (obligatoire, chaîne) | ID d’essai d’analyse non secrète aléatoire, jamais d’autorisation. motif : "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" |
Modèle de requête et réponses
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'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | Requête enregistrée de façon durable. Définit un cookie de session de démonstration privé. | DemoResult (application/json) |
| 200 | Rejeu idempotent correspondant de la requête enregistrée. | DemoResult (application/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 la demande de démonstration du site Web
Requête enregistrée liée au cookie. Un ID de requête ou un ID de flux public ne donne pas accès. Pas de stockage.
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-request'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Requête de démonstration et état de réservation enregistrés. | DemoResult (application/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 calendrier de démonstration du site Web
Téléchargement privé du calendrier pour la réservation confirmée de ce navigateur. Revérifie l’événement enregistré ; aucun ID de requête ni ID de flux public ne donne accès. Pas de stockage.
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-calendar'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Événement de calendrier importable avec identité stable et horaires confirmés. | chaîne (text/calendar) |
| 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 les plages de démonstration du site Web
Jusqu’à quatre créneaux réels disponibles de 30 minutes, variés selon les dates et heures lorsque possible, dans le fuseau horaire IANA modifiable du visiteur. Les ID privés des créneaux sont retournés dans le corps JSON et jamais envoyés dans les requêtes URL. Calendrier non configuré ou absence de chevauchement raisonnable de fuseau horaire renvoie une liste vide.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| fuseau horaire | requête | obligatoire | |
| rafraîchir | requête | optionnel | Offrir des alternatives au lot précédent lié aux cookies. |
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/website/demo-slots?timezone=TIMEZONE'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Créneaux disponibles réels ou liste vide. | DemoSlots (application/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) |
Réserver une démo de site Web
Revérifie un créneau lié à un cookie, réserve atomiquement des cellules de tampon hôte et crée un événement stable dans le calendrier local ou Google configuré. La confirmation nécessite l’événement réel et la réservation enregistrée. Les échecs ambigus du fournisseur restent en attente pour une réconciliation durable, sans second événement ni fausse page réservée.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| Origine | en-tête | obligatoire | Requête navigateur même origine ; l’origine de scène configurée est acceptée sur scène. |
| f | requête | optionnel | ID de tentative de tunnel non secret, identique au flow_id enregistré. |
| src | requête | optionnel | Source autorisée enregistrée. |
Champs du corps de la requête
| Champ | Description |
|---|---|
| slot_id (obligatoire, chaîne) | Vide uniquement pour la relecture d’une réservation déjà confirmée liée à un cookie. Modèle : « ^([A-Za-z0-9_-]{20,128})?$ » |
| fuseau horaire (obligatoire, chaîne) | maxLength : 100 |
Modèle de requête et réponses
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'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | Événement de calendrier et réservation confirmés et enregistrés. | DemoResult (application/json) |
| 200 | Relecture de réservation déjà confirmée. | DemoResult (application/json) |
| 202 | Réservation en attente de réconciliation fournisseur ; exclue des analyses de réservations confirmées. | DemoResult (application/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) |
| 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) |
Demander une révision de démonstration du site Web
Signale la demande à la demande existante pour révision par l’équipe sans autre questionnaire. Les réponses tardives du classificateur ne peuvent pas inverser ce choix.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| Origine | en-tête | obligatoire | Requête navigateur même origine ; l’origine de scène configurée est acceptée sur scène. |
Modèle de requête et réponses
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'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Requête sauvegardée actuelle avec revue demandée. | DemoResult (application/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) |
Invitation de démonstration du site Exchange
Échange une invitation de réservation par courriel valable sept jours pour une session de démonstration HttpOnly accessible uniquement par navigateur. Le site supprime son fragment d’invitation avant toute requête et envoie le jeton uniquement dans ce corps POST privé, jamais dans une URL, redirection, marqueur d’analyse ou journal. Plusieurs sessions de navigateur peuvent accéder à la même requête liée à l’invitation.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| Origine | en-tête | obligatoire | Requête navigateur même origine ; l’origine de scène configurée est acceptée sur scène. |
Champs du corps de la requête
| Champ | Description |
|---|---|
| jeton (obligatoire, chaîne) | modèle : "^[A-Za-z0-9_-]{20,128}$" |
Modèle de requête et réponses
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'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Requête de démonstration avec cookie défini et enregistré retournée. | DemoResult (application/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) |