OpenAPI YAMLOpenAPI JSONproblèmes YAMLVue d’ensemble de l’API
Ce groupe compte 1 opération, générée à 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.
Codes de configuration du site Web
Obtenir le code de configuration du visiteur
Appel anonyme de même origine depuis les invites d’agent du site Web. Répond avec le code de configuration du cookie de visiteur propriétaire (sr_vid) de la requête, en le créant la première fois : le même visiteur obtient le même code tant qu’il est valide (90 jours après sa création).
La personne le colle dans son agent avec l’invite de configuration, et l’agent le transmet à l’enrôlement de la CLI, qui lie le nouveau projet à cette visite. Exige l’Origin du site Web. Une requête qui n’a pas exactement un cookie de visiteur bien formé reçoit 204 et ne crée rien. Le code n’accorde rien ; il ne fait que nommer une visite.
Au plus 60 nouveaux codes par IP cliente et par heure (IPv6 regroupées par /64) ; toutes les requêtes partagent une limite de 120 par IP et par minute. Retry-After fait foi.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| Origine | en-tête | obligatoire |
Modèle de requête et réponses
curl --request POST --header 'Origin: https://screenrig.ai' 'https://screenrig.ai/website/setup-codes'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Le code de configuration du visiteur. | WebsiteSetupCode (application/json); en-têtes : Cache-Control |
| 204 | La requête ne portait aucun cookie de visiteur : il n’y a donc aucune visite à nommer. | pas de corps; en-têtes : Cache-Control |
| 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) |