OpenAPI YAMLOpenAPI JSONproblemi YAMLPanoramica dell’API
Questo gruppo ha 9 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.
Archiviazione chiave/valore applicazione
Elenca KV
Restituisce al massimo 200 voci in ordine crescente di chiave. next_cursor è l’ultima chiave restituita; passala come after per ottenere la pagina successiva. next_cursor è null quando non ci sono più voci. Una sessione della dashboard legge qui le voci del suo progetto per l’anteprima dell’app web; la dashboard non ha scrittura KV.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| application_id | path | obbligatorio | |
| dopo | query | opzionale |
Modello richiesta e risposte
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Voci KV | KVList (application/json) |
| 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) |
Ottieni KV
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| application_id | path | obbligatorio | |
| key | path | obbligatorio |
Modello richiesta e risposte
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv/KEY'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Voce KV | KVEntry (application/json) |
| 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) |
Inserisci KV
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| 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
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv/KEY'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Voce KV | KVEntry (application/json) |
| 429 | Problema rate_limited stabile. Ritenta solo dopo l'intervallo Retry-After autorevole. I dinieghi a finestra fissa includono anche RateLimit-Policy e membri RateLimit applicabili; i dinieghi per concorrenza e budget byte omettono tali divulgazioni opzionali. | Problema (application/problem+json); intestazioni: Retry-After, RateLimit-Policy, RateLimit |
| 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) |
Elimina KV
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| 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
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv/KEY'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 204 | Eliminato | nessun corpo |
| 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) |
Elenca webhook KV
Elenca i webhook key/value in ingresso dell’applicazione, dal più vecchio (massimo 20), ognuno con la chiave scritta, la sua URL di ingestione e last_used_at una volta scritta. Il segreto non è mai restituito qui
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| application_id | path | obbligatorio |
Modello richiesta e risposte
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | I webhook key/value dell’applicazione. | KVWebhookList (application/json) |
| 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) |
Crea KVWebhook
Crea un webhook in ingresso chiave/valore: un URL che scrive una chiave di questa applicazione, così un sistema esterno (Zapier, Make, un punto vendita, un cron job, curl) invia dati agli schermi con un POST HTTP; vedi POST /api/applications/{application_id}/kv-webhooks/{webhook_id}/write. La chiave può non esistere ancora.
La risposta è l’unico luogo in cui appare il segreto (con la risposta di rotazione): memorizzalo subito nel sistema di invio; il server conserva un digest. Un’applicazione ha al massimo 20 webhook (kv_webhook_limit_reached). Aggiunge kv_webhook.created. Un retry esatto con la stessa Idempotency-Key restituisce la stessa risposta, segreto incluso, per ventiquattro ore.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| application_id | path | obbligatorio | |
| 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 |
|---|---|
| key (obbligatorio, stringa) | minLength: 1 maxLength: 256 pattern: "^[A-Za-z0-9][A-Za-z0-9._:/-]{0,255}$" |
| descrizione (opzionale, stringa) | Cosa invia a esso, per le persone che leggono la lista. Ridotto; non deve contenere credenziali. maxLength: 200 |
Modello richiesta e risposte
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 201 | Creato, con il suo URL e segreto. | KVWebhookWithSecret (application/json); headers: Cache-Control |
| 400 | invalid_request, incluso una chiave malformata o una descrizione che contiene una credenziale. | Problema (application/problem+json) |
| 404 | not_found — l’applicazione non è in questo progetto. | Problema (application/problem+json) |
| 409 | kv_webhook_limit_reached o idempotency_mismatch. | Problema (application/problem+json) |
| 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) |
Elimina KVWebhook
Elimina il webhook. La sua URL smette di funzionare immediatamente; la chiave scritta mantiene il suo valore. Aggiunge kv_webhook.deleted.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| application_id | path | obbligatorio | |
| webhook_id | path | obbligatorio | L’id di uno dei webhook chiave/valore dell’applicazione. |
| 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
curl --request DELETE --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 204 | Eliminato. | nessun corpo |
| 404 | not_found — il webhook non è su questa applicazione. | Problema (application/problem+json) |
| 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) |
Ruota KVWebhook Secret
Sostituisce il segreto del webhook e restituisce quello nuovo, una volta. Il vecchio segreto smette di funzionare subito; aggiorna il sistema di invio. Aggiunge kv_webhook.secret_rotated. Un retry esatto con la stessa Idempotency-Key restituisce questa stessa risposta, segreto incluso, per ventiquattro ore.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| application_id | path | obbligatorio | |
| webhook_id | path | obbligatorio | L’id di uno dei webhook chiave/valore dell’applicazione. |
| 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
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID/rotate-secret'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Il webhook con il suo nuovo segreto. | KVWebhookWithSecret (application/json); headers: Cache-Control |
| 404 | not_found — il webhook non è su questa applicazione. | Problema (application/problem+json) |
| 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) |
Ricevi KVWebhook
L’URL a cui un sistema esterno invia il nuovo valore di una chiave. Si autentica solo con il segreto del webhook nell’intestazione Authorization: Bearer <secret>, o HTTP Basic con l’ID webhook come nome utente e il segreto come password. Un segreto nell’URL o nella query non è mai accettato.
Un webhook sconosciuto, uno di un’altra applicazione e un segreto errato rispondono tutti con lo stesso 401. Il corpo raw, massimo 1 MiB, diventa il valore della chiave del webhook, e l’header Content-Type il suo content_type (application/octet-stream se assente; un header che non è un tipo media è invalid_request).
La scrittura è PUT /api/applications/{application_id}/kv/{key} senza If-Match: sostituisce il valore, incrementa la revisione, è conteggiata e controllata per quota come ogni scrittura K/V, è una richiesta API fatturata che non viene mai rifiutata per il saldo, e aggiunge kv.updated.
Idempotency-Key (da 8 a 200 caratteri) deduplica i nuovi tentativi di invio di una scrittura per ventiquattro ore, e la stessa chiave con un corpo o tipo di contenuto diverso è idempotency_mismatch; senza di essa ogni invio è una nuova scrittura. La risposta contiene i nuovi metadati della chiave, mai il suo valore.
Al massimo 120 scritture al minuto per webhook; ciascuna conta anche nei limiti di scrittura dell’organizzazione e della chiave (PUT /api/card-data/{key}).
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| application_id | path | obbligatorio | |
| webhook_id | path | obbligatorio | L’id di uno dei webhook chiave/valore dell’applicazione. |
| 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
curl --request POST --header 'Content-Type: */*' --data-binary '@request.bin' 'https://api.screenrig.ai/api/applications/APPLICATION_ID/kv-webhooks/WEBHOOK_ID/write'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | I nuovi metadati della chiave. | KVWebhookWriteResult (application/json); headers: RateLimit-Policy, RateLimit, Cache-Control |
| 400 | invalid_request — il corpo è più grande di 1 MiB, il Content-Type non è un tipo media unico, o la Idempotency-Key è malformata. | Problema (application/problem+json) |
| 401 | non autorizzato — credenziali mancanti o errate, o webhook sconosciuto. WWW-Authenticate indica i realm Bearer e Basic. | Problema (application/problem+json) |
| 409 | idempotency_mismatch — la Idempotency-Key è stata usata per un altro corpo o tipo di contenuto. | Problema (application/problem+json) |
| 429 | Problema rate_limited stabile. Ritenta solo dopo l'intervallo Retry-After autorevole. I dinieghi a finestra fissa includono anche RateLimit-Policy e membri RateLimit applicabili; i dinieghi per concorrenza e budget byte omettono tali divulgazioni opzionali. | Problema (application/problem+json); intestazioni: Retry-After, RateLimit-Policy, RateLimit |
| 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) |