{"revision":"0ed62d2c742f8e20","language":"it","entry":{"id":"create-api-key","kind":"endpoint","group":"developer","title":"Crea una chiave di integrazione","method":"POST","path":"/v1/developer/accounts/{n}/keys","paths":[],"summary":"Una persona o un proprietario dell’organizzazione firma la richiesta per emettere una chiave Bearer segreta.","response":"201 con i metadati key e secret. Il segreto viene restituito soltanto qui e non può essere recuperato.","parameters":[{"name":"n","in":"path","required":true,"description":"Numero permanente della persona o organizzazione titolare della quota."}],"sample":"/v1/developer/accounts/1/keys","access":"signed","base":"directory","notes":["Il titolare firma con una chiave di dispositivo attiva. Per l’organizzazione serve un proprietario con appartenenza accettata. Le chiavi API Bearer non autorizzano questa chiamata.","La risposta è privata e usa Cache-Control no-store.","Le scritture di gestione accettano al massimo 8 KiB e rifiutano i campi sconosciuti. nonce e timestamp sono i campi comuni della firma."],"errors":["400 invalid_json","400 invalid_nonce","400 invalid_parameter","400 invalid_signature_alg","400 invalid_timestamp","401 invalid_signature","401 missing_signature","401 stale_timestamp","403 developer_suspended","403 identity_banned","403 key_banned","403 key_mismatch","404 not_found","409 api_key_limit","409 replayed_nonce","413 payload_too_large","429 rate_limited","500 internal_error","503 busy"],"related":["api-keys"],"sections":[{"kind":"code","language":"shell","code":"curl -fsS -X POST \\\n  -H \"X-Public-Key: $PUBLIC_KEY\" -H \"X-Signature: $REQUEST_SIGNATURE\" \\\n  --json @request.json \"https://veil.rip/v1/developer/accounts/1/keys\""}],"live":false,"bodyFields":[{"name":"label","in":"body","required":true,"description":"Nome dell’integrazione, da 1 a 60 caratteri."},{"name":"scopes","in":"body","required":false,"description":"Array contenente read e/o verify. Entrambi sono abilitati per impostazione predefinita."},{"name":"expiresInDays","in":"body","required":false,"description":"Da 1 a 365, valore predefinito 90."}],"responses":[{"status":201,"contentType":"application/json","description":"201 con i metadati key e secret. Il segreto viene restituito soltanto qui e non può essere recuperato.","fields":[{"name":"key","type":"ApiKey","description":"Metadati della chiave creata."},{"name":"secret","type":"string","description":"Credenziale Bearer mostrata una sola volta. Salvala ora; nessuna risposta successiva può recuperarla."}],"example":{"language":"json","code":"{\n  \"key\": {\n    \"id\": \"0123456789abcdef0123456789abcdef\",\n    \"owner\": 1,\n    \"label\": \"Website backend\",\n    \"prefix\": \"veil_live_01234567…\",\n    \"scopes\": [\n      \"read\",\n      \"verify\"\n    ],\n    \"state\": \"active\",\n    \"createdAt\": \"2026-10-27T00:00:00Z\",\n    \"expiresAt\": \"2027-01-25T00:00:00Z\",\n    \"revokedAt\": null,\n    \"suspended\": false,\n    \"requestsPerMinute\": null,\n    \"lastUsedAt\": null,\n    \"requests\": 0\n  },\n  \"secret\": \"<save-the-one-time-secret-here>\"\n}"}}],"responseObjects":[{"id":"api-key","title":"Metadati della chiave API","fields":[{"name":"id","type":"string","description":"ID pubblico di gestione della chiave, non il segreto Bearer."},{"name":"owner","type":"integer","description":"Numero permanente della scheda titolare."},{"name":"label","type":"string","description":"Etichetta dell’integrazione scelta dal titolare."},{"name":"prefix","type":"string","description":"Prefisso visualizzato non segreto."},{"name":"scopes","type":"array<string>","description":"read e/o verify."},{"name":"state","type":"string","description":"active, expired, suspended o revoked. La sospensione dell’account è indicata separatamente."},{"name":"createdAt","type":"string","description":"Data e ora di creazione in ISO 8601 UTC."},{"name":"expiresAt","type":"string","description":"Scadenza in ISO 8601 UTC."},{"name":"revokedAt","type":"string | null","description":"Data e ora della revoca permanente."},{"name":"suspended","type":"boolean","description":"Indica se questa chiave è sospesa."},{"name":"requestsPerMinute","type":"integer | null","description":"Limite aggiuntivo della chiave, oppure null."},{"name":"lastUsedAt","type":"string | null","description":"Ultimo uso ammesso, oppure null se mai usata."},{"name":"requests","type":"integer","description":"Richieste ammesse durante la vita della chiave."}],"typeName":"ApiKey"}],"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_nonce","description":"Il nonce della richiesta firmata ha un formato errato.","action":"Genera un nuovo nonce da 16 a 128 caratteri usando lettere, cifre, _ o -.","scope":"common"},{"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":400,"code":"invalid_signature_alg","description":"`X-Signature-Alg` non è supportato.","action":"Usa un algoritmo di firma supportato e la codifica corretta per chiave e firma.","scope":"common"},{"status":400,"code":"invalid_timestamp","description":"Il timestamp della richiesta firmata non è espresso in millisecondi Unix.","action":"Usa un timestamp Unix intero in millisecondi e firma la richiesta corretta.","scope":"common"},{"status":401,"code":"invalid_signature","description":"La firma della richiesta HTTP non è valida.","action":"Firma metodo, percorso e byte del corpo esatti, senza modificarli dopo.","scope":"common"},{"status":401,"code":"missing_signature","description":"La richiesta richiede una firma del dispositivo e le intestazioni mancano o non sono leggibili.","action":"Invia `X-Public-Key`, `X-Signature` e i metadati della richiesta firmata. Una chiave API non sostituisce la firma del dispositivo.","scope":"common"},{"status":401,"code":"stale_timestamp","description":"Il timestamp firmato è fuori dalla finestra temporale ammessa.","action":"Confronta l’intestazione Date del server con il tuo orologio, poi genera nuovi nonce, timestamp e firma.","scope":"common"},{"status":403,"code":"developer_suspended","description":"L’account API del titolare è sospeso oppure la scheda titolare non è disponibile.","action":"Controlla l’account titolare e le restrizioni dello staff. Creare un’altra chiave non aggira la sospensione.","scope":"endpoint"},{"status":403,"code":"identity_banned","description":"La scheda che agisce è sospesa dallo staff di Veil.","action":"Attendi la fine della restrizione o chiedi allo staff di riesaminarla.","scope":"endpoint"},{"status":403,"code":"key_banned","description":"La chiave del dispositivo che firma è sospesa dallo staff di Veil.","action":"Usa una chiave attiva autorizzata o chiedi allo staff di riesaminare la restrizione.","scope":"common"},{"status":403,"code":"key_mismatch","description":"La chiave di firma non è autorizzata per questa scheda o operazione.","action":"Usa una chiave di dispositivo attiva con il ruolo di titolare o membro richiesto.","scope":"endpoint"},{"status":404,"code":"not_found","description":"La scheda, la chiave, l’alias, il codice o la risorsa richiesti non sono stati trovati.","action":"Controlla l’identificatore. Codici e anteprime temporanei potrebbero essere scaduti o già usati.","scope":"endpoint"},{"status":409,"code":"api_key_limit","description":"Il titolare ha già 20 chiavi API non scadute e non revocate.","action":"Revoca una chiave inutilizzata prima di crearne un’altra. Le chiavi sospese vengono conteggiate.","scope":"endpoint"},{"status":409,"code":"replayed_nonce","description":"La chiave di firma ha già usato questo nonce.","action":"Controlla se la richiesta precedente è riuscita prima di crearne una nuova firmata.","scope":"common"},{"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/create-api-key?lang=it","supportsBrowserFetch":false,"browserMode":"local-or-server"}}