Codici di configurazione: riferimento API, endpoint ed esempi

OpenAPI YAML OpenAPI JSON problemi YAML Panoramica dell’API

Questo gruppo ha 1 operazione, generata da api/openapi.yaml. Filtra per percorso, azione o autenticazione. Ogni endpoint elenca i suoi input; espandilo per vedere un modello di richiesta e i codici di risposta. I modelli richiedono i tuoi valori e un corpo valido secondo lo schema.

Sostituisci i segnaposto maiuscoli con i tuoi valori. Per una richiesta JSON, salva un corpo che corrisponde allo schema in request.json. Gli esempi di cookie usano un cookie jar locale da una sessione autenticata.

Codici di configurazione del sito

POST/website/setup-codes¶

Ottenere il codice di configurazione del visitatore

Chiamata anonima della stessa origine dai prompt agente del sito. Risponde con il codice di configurazione del cookie del visitatore di prima parte della richiesta (sr_vid), generandolo la prima volta: lo stesso visitatore riceve lo stesso codice finché è valido (90 giorni dalla generazione).

Una persona lo incolla nel proprio agente insieme al prompt di configurazione e l’agente lo passa alla registrazione della CLI, che collega il nuovo progetto a quella visita. Richiede l’Origin del sito. Una richiesta senza esattamente un cookie del visitatore ben formato riceve 204 e non genera nulla. Il codice non concede nulla; indica soltanto una visita.

Al massimo 60 nuovi codici per IP client all’ora (IPv6 raggruppati per /64); tutte le richieste condividono un limite di 120 per IP al minuto. Fa fede Retry-After.

Autenticazione: nessuno
Corpo della richiesta: nessuno
ID operazione: createWebsiteSetupCode

Parametri

Nome	Invia	Obbligatorio?	Descrizione
Origine	intestazione	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

curl --request POST --header 'Origin: https://screenrig.ai' 'https://screenrig.ai/website/setup-codes'

Risposte

Stato	Significato	Corpo e intestazioni
200	Il codice di configurazione del visitatore.	WebsiteSetupCode (application/json); intestazioni: Cache-Control
204	La richiesta non conteneva alcun cookie del visitatore, quindi non c’è nessuna visita da indicare.	nessun corpo; intestazioni: Cache-Control
predefinito	Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore.	Problema (application/problem+json)