{"revision":"0ed62d2c742f8e20","language":"it","entry":{"id":"request-device","kind":"endpoint","group":"manage","title":"Chiedi l’accoppiamento di un dispositivo","method":"POST","path":"/v1/device-requests","paths":[],"summary":"Crea un codice temporaneo di accoppiamento per la chiave pubblica di un nuovo dispositivo.","response":"201 con code, display, key, alg, device, createdAt ed expiresAt. Il codice dura dieci minuti.","parameters":[],"sample":"/v1/device-requests","access":"public-write","base":"directory","notes":["La creazione dei codici è limitata a 10 all’ora per IP. La lettura dei codici è limitata a 5 al minuto per IP e richiede una chiave attiva di una persona."],"errors":["400 invalid_json","400 invalid_name","400 invalid_parameter","409 key_already_used","413 payload_too_large","429 rate_limited","500 internal_error","503 busy"],"related":[],"sections":[{"kind":"code","language":"shell","code":"curl -fsS -X POST 'https://veil.rip/v1/device-requests' --json @request.json"}],"bodyFields":[{"name":"key","description":"La chiave pubblica del nuovo dispositivo.","in":"body","required":true},{"name":"alg","description":"ed25519 oppure mldsa65-ed25519.","in":"body","required":false},{"name":"device","description":"Nome del dispositivo da 1 a 40 caratteri.","in":"body","required":true}],"live":false,"responses":[{"status":201,"contentType":"application/json","description":"201 con code, display, key, alg, device, createdAt ed expiresAt. Il codice dura dieci minuti.","fields":[{"name":"code","type":"string","description":"Codice privato di accoppiamento di otto caratteri."},{"name":"display","type":"string","description":"Codice raggruppato per la digitazione."},{"name":"key","type":"string","description":"Chiave pubblica in attesa."},{"name":"alg","type":"string","description":"Identificatore dell’algoritmo di firma."},{"name":"ed25519","type":"string","description":"Chiave Ed25519 o metà composita, in hex."},{"name":"device","type":"string","description":"Etichetta richiesta del dispositivo."},{"name":"createdAt","type":"string","description":"Data e ora di creazione."},{"name":"expiresAt","type":"string","description":"Scadenza, dieci minuti dopo la creazione."}]}],"responseObjects":[],"errorFormat":"json","errorDetails":[{"status":400,"code":"invalid_json","description":"Il corpo non è un oggetto JSON, contiene chiavi duplicate o dati finali.","action":"Invia un solo oggetto JSON valido con `Content-Type` application/json.","scope":"endpoint"},{"status":400,"code":"invalid_name","description":"Un nome contiene caratteri invisibili, controlli di direzione o caratteri di formato non ammessi.","action":"Usa un nome visibile nella forma Unicode ammessa e firma la richiesta corretta.","scope":"endpoint"},{"status":400,"code":"invalid_parameter","description":"Un campo del percorso, della query o del corpo manca, è malformato o fuori intervallo.","action":"Correggi il campo indicato in `error.message` prima di inviare di nuovo.","scope":"endpoint"},{"status":409,"code":"key_already_used","description":"Una chiave del dispositivo appartiene già a un’identità e non può essere riusata da un’altra.","action":"Usa la scheda esistente oppure genera una nuova chiave del dispositivo.","scope":"endpoint"},{"status":413,"code":"payload_too_large","description":"Il corpo della richiesta supera il limite in byte dell’endpoint.","action":"Riduci il corpo codificato. La gestione delle chiavi API ammette al massimo 8 KiB.","scope":"endpoint"},{"status":429,"code":"rate_limited","description":"È stato superato un limite anonimo, delle richieste firmate o della chiave API.","action":"Attendi almeno i secondi indicati da `Retry-After`. Condividi coda e budget dei tentativi tra i tuoi processi.","scope":"common"},{"status":500,"code":"internal_error","description":"Si è verificato un errore imprevisto del server. I dettagli interni non vengono restituiti.","action":"Riprova le letture con attese crescenti e un limite. Controlla l’esito delle scritture prima di inviare una nuova operazione firmata.","scope":"common"},{"status":503,"code":"busy","description":"L’applicazione ha raggiunto un limite temporaneo di concorrenza o del database.","action":"Attendi i secondi indicati da `Retry-After` e riprova con attese crescenti e un limite.","scope":"common"}],"responseHeaders":[{"name":"Content-Type","value":"application/json","description":"Usa il tipo dichiarato per scegliere come leggere il corpo."},{"name":"Date","value":"HTTP date","description":"Ora del server. Confrontala con il tuo orologio per firmare le richieste."},{"name":"Cache-Control","value":"no-store","description":"Non conservare le risposte private o temporanee in una cache condivisa."},{"name":"Retry-After","value":"integer seconds, on rate_limited or busy","description":"Attendi almeno questo intervallo prima di riprovare. Altri codici 429/503 non lo includono necessariamente."}],"documentationUrl":"https://veil.rip/docs/request-device?lang=it","supportsBrowserFetch":false,"browserMode":"local-or-server"}}