Archiviazione applicazione: riferimento API, endpoint ed esempi

OpenAPI YAML OpenAPI JSON problemi YAML Panoramica dell’API

Questo gruppo ha 4 operazioni, generate 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.

K/V applicazione runtime

GET/screen/apps/{application_id}/kv¶

Elenca le chiavi runtime KV

Restituisce al massimo 200 voci in ordine crescente di chiave e non fa paginazione; uno spazio nomi con più chiavi è elencato solo parzialmente. Elenca i metadati per un’applicazione contenuta nel contenuto corrente dello schermo.

Runtime KV è autorizzato dalla sessione runtime del Player (kv.read e kv.write per scritture) e dalla concessione corrente dello schermo, che deve contenere una release pronta dell’applicazione; un header ScreenRig-Primitive-Capability è ignorato. I frame caricati non chiamano mai queste rotte e devono usare il bridge SDK parent convalidato.

Autenticazione: runtimeCookie OR nativeSessionAuthorization
Corpo della richiesta: nessuno
ID operazione: listRuntimeKV

Parametri

Nome	Invia	Obbligatorio?	Descrizione
application_id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv'

Risposte

Stato	Significato	Corpo e intestazioni
200	KV applicazione autorizzata dal manifesto	RuntimeKVList (application/json)
predefinito	Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). 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.	RuntimeProblem (application/problem+json)

GET/screen/apps/{application_id}/kv/{key}¶

Ottieni runtime KV

Autenticazione: runtimeCookie OR nativeSessionAuthorization
Corpo della richiesta: nessuno
ID operazione: getRuntimeKV

Parametri

Nome	Invia	Obbligatorio?	Descrizione
application_id	path	obbligatorio
key	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

Risposte

Stato	Significato	Corpo e intestazioni
200	Valore KV applicazione autorizzata dal manifesto	RuntimeKVEntry (application/json)
predefinito	Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). 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.	RuntimeProblem (application/problem+json)

PUT/screen/apps/{application_id}/kv/{key}¶

Inserisci KV runtime

Autenticazione: pairedRuntimeCookie O nativeSessionAuthorization
Corpo della richiesta: Scrittura RuntimeKV
ID operazione: putRuntimeKV

Parametri

Nome	Invia	Obbligatorio?	Descrizione
application_id	path	obbligatorio
key	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per creare o sovrascrivere una chiave; una revisione obsoleta fornita è revision_conflict.
Idempotency-Key	intestazione	opzionale	Ometti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.

Campi del corpo della richiesta

Campo	Descrizione
value_base64 (obbligatorio, stringa)	maxLength: 1398104
content_type (opzionale, stringa)	predefinito: "application/octet-stream" minLength: 1 maxLength: 127

Modello richiesta e risposte

shell · modello richiesta

curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

Risposte

Stato	Significato	Corpo e intestazioni
200	Mutazione KV dispositivo associato	RuntimeKVEntry (application/json); intestazioni: RateLimit-Policy, RateLimit
predefinito	Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). 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.	RuntimeProblem (application/problem+json)

ELIMINA/screen/apps/{application_id}/kv/{key}¶

Elimina KV runtime

Autenticazione: pairedRuntimeCookie O nativeSessionAuthorization
Corpo della richiesta: nessuno
ID operazione: deleteRuntimeKV

Parametri

Nome	Invia	Obbligatorio?	Descrizione
application_id	path	obbligatorio
key	path	obbligatorio
If-Match	intestazione	opzionale	Revisione positiva opzionale della risorsa. Ometti per scrivere la risorsa corrente; una revisione obsoleta fornita è revision_conflict.
Idempotency-Key	intestazione	opzionale	Ometti per un’operazione fresca. Fornisci e riutilizza una chiave per deduplicare i retry; la CLI gestisce automaticamente le chiavi.

Modello richiesta e risposte

shell · modello richiesta

curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://play.screenrig.ai/screen/apps/APPLICATION_ID/kv/KEY'

Risposte

Stato	Significato	Corpo e intestazioni
204	Eliminazione KV dispositivo associato	nessun corpo; intestazioni: RateLimit-Policy, RateLimit
predefinito	Risposta problema stabile RFC 9457 su runtime, contenuto o percorso probe rivolto al Player, nella forma documento runtime (RuntimeProblem). 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.	RuntimeProblem (application/problem+json)