Crea una chiave di integrazione

Una persona o un proprietario dell’organizzazione firma la richiesta per emettere una chiave Bearer segreta.

POST/v1/developer/accounts/{n}/keys

Accesso: Richiesta firmata
Client: Client locale o server

Parametri#

Nome	Posizione	Significato
`n`Obbligatorio	Percorso	Numero permanente della persona o organizzazione titolare della quota.

Corpo JSON#

Nome	Posizione	Significato
`label`Obbligatorio	JSON	Nome dell’integrazione, da 1 a 60 caratteri.
`scopes`	JSON	Array contenente read e/o verify. Entrambi sono abilitati per impostazione predefinita.
`expiresInDays`	JSON	Da 1 a 365, valore predefinito 90.

Questa chiamata richiede anche le intestazioni comuni di firma, nonce e timestamp. Prepara e firma request.json prima di usare l’esempio. Firma delle richieste

Esempi di richiesta#

cURL

curl -fsS -X POST \
  -H "X-Public-Key: $PUBLIC_KEY" -H "X-Signature: $REQUEST_SIGNATURE" \
  --json @request.json "https://veil.rip/v1/developer/accounts/1/keys"

Risposta#

HTTP 201application/json

201 con i metadati key e secret. Il segreto viene restituito soltanto qui e non può essere recuperato.

Campo	Tipo	Significato
`key`	`ApiKey`	Metadati della chiave creata.
`secret`	`string`	Credenziale Bearer mostrata una sola volta. Salvala ora; nessuna risposta successiva può recuperarla.

Esempio di risposta

Valori illustrativi. Leggi la risposta corrente della tua richiesta.

json

{
  "key": {
    "id": "0123456789abcdef0123456789abcdef",
    "owner": 1,
    "label": "Website backend",
    "prefix": "veil_live_01234567…",
    "scopes": [
      "read",
      "verify"
    ],
    "state": "active",
    "createdAt": "2026-10-27T00:00:00Z",
    "expiresAt": "2027-01-25T00:00:00Z",
    "revokedAt": null,
    "suspended": false,
    "requestsPerMinute": null,
    "lastUsedAt": null,
    "requests": 0
  },
  "secret": "<save-the-one-time-secret-here>"
}

Apri un oggetto annidato per leggerne i campi. I tipi con null ammettono un valore null; i campi optional possono essere assenti. Gli altri campi sono presenti nell’oggetto.

Metadati della chiave API ApiKey

Campo	Tipo	Significato
`id`	`string`	ID pubblico di gestione della chiave, non il segreto Bearer.
`owner`	`integer`	Numero permanente della scheda titolare.
`label`	`string`	Etichetta dell’integrazione scelta dal titolare.
`prefix`	`string`	Prefisso visualizzato non segreto.
`scopes`	`array<string>`	read e/o verify.
`state`	`string`	active, expired, suspended o revoked. La sospensione dell’account è indicata separatamente.
`createdAt`	`string`	Data e ora di creazione in ISO 8601 UTC.
`expiresAt`	`string`	Scadenza in ISO 8601 UTC.
`revokedAt`	`string \| null`	Data e ora della revoca permanente.
`suspended`	`boolean`	Indica se questa chiave è sospesa.
`requestsPerMinute`	`integer \| null`	Limite aggiuntivo della chiave, oppure null.
`lastUsedAt`	`string \| null`	Ultimo uso ammesso, oppure null se mai usata.
`requests`	`integer`	Richieste ammesse durante la vita della chiave.

Intestazioni della risposta#

Intestazione	Valore	Significato
`Content-Type`	`application/json`	Usa il tipo dichiarato per scegliere come leggere il corpo.
`Date`	`HTTP date`	Ora del server. Confrontala con il tuo orologio per firmare le richieste.
`Cache-Control`	`no-store`	Non conservare le risposte private o temporanee in una cache condivisa.
`Retry-After`	`integer seconds, on rate_limited or busy`	Attendi almeno questo intervallo prima di riprovare. Altri codici 429/503 non lo includono necessariamente.

Note d’uso#

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.

Errori#

Gli errori API restituiscono un oggetto error. Usa error.code nella logica del programma; error.message è un testo inglese per le persone e può cambiare. Guida a risposte ed errori

HTTP	Codice	Significato e cosa fare
400	`invalid_json`	Il corpo non è un oggetto JSON, contiene chiavi duplicate o dati finali. Invia un solo oggetto JSON valido con `Content-Type` application/json.
400	`invalid_parameter`	Un campo del percorso, della query o del corpo manca, è malformato o fuori intervallo. Correggi il campo indicato in `error.message` prima di inviare di nuovo.
403	`developer_suspended`	L’account API del titolare è sospeso oppure la scheda titolare non è disponibile. Controlla l’account titolare e le restrizioni dello staff. Creare un’altra chiave non aggira la sospensione.
403	`identity_banned`	La scheda che agisce è sospesa dallo staff di Veil. Attendi la fine della restrizione o chiedi allo staff di riesaminarla.
403	`key_mismatch`	La chiave di firma non è autorizzata per questa scheda o operazione. Usa una chiave di dispositivo attiva con il ruolo di titolare o membro richiesto.
404	`not_found`	La scheda, la chiave, l’alias, il codice o la risorsa richiesti non sono stati trovati. Controlla l’identificatore. Codici e anteprime temporanei potrebbero essere scaduti o già usati.
409	`api_key_limit`	Il titolare ha già 20 chiavi API non scadute e non revocate. Revoca una chiave inutilizzata prima di crearne un’altra. Le chiavi sospese vengono conteggiate.
413	`payload_too_large`	Il corpo della richiesta supera il limite in byte dell’endpoint. Riduci il corpo codificato. La gestione delle chiavi API ammette al massimo 8 KiB.

Errori comuni delle richieste

HTTP	Codice	Significato e cosa fare
400	`invalid_nonce`	Il nonce della richiesta firmata ha un formato errato. Genera un nuovo nonce da 16 a 128 caratteri usando lettere, cifre, _ o -.
400	`invalid_signature_alg`	`X-Signature-Alg` non è supportato. Usa un algoritmo di firma supportato e la codifica corretta per chiave e firma.
400	`invalid_timestamp`	Il timestamp della richiesta firmata non è espresso in millisecondi Unix. Usa un timestamp Unix intero in millisecondi e firma la richiesta corretta.
401	`invalid_signature`	La firma della richiesta HTTP non è valida. Firma metodo, percorso e byte del corpo esatti, senza modificarli dopo.
401	`missing_signature`	La richiesta richiede una firma del dispositivo e le intestazioni mancano o non sono leggibili. Invia `X-Public-Key`, `X-Signature` e i metadati della richiesta firmata. Una chiave API non sostituisce la firma del dispositivo.
401	`stale_timestamp`	Il timestamp firmato è fuori dalla finestra temporale ammessa. Confronta l’intestazione Date del server con il tuo orologio, poi genera nuovi nonce, timestamp e firma.
403	`key_banned`	La chiave del dispositivo che firma è sospesa dallo staff di Veil. Usa una chiave attiva autorizzata o chiedi allo staff di riesaminare la restrizione.
409	`replayed_nonce`	La chiave di firma ha già usato questo nonce. Controlla se la richiesta precedente è riuscita prima di crearne una nuova firmata.
429	`rate_limited`	È stato superato un limite anonimo, delle richieste firmate o della chiave API. Attendi almeno i secondi indicati da `Retry-After`. Condividi coda e budget dei tentativi tra i tuoi processi.
500	`internal_error`	Si è verificato un errore imprevisto del server. I dettagli interni non vengono restituiti. Riprova le letture con attese crescenti e un limite. Controlla l’esito delle scritture prima di inviare una nuova operazione firmata.
503	`busy`	L’applicazione ha raggiunto un limite temporaneo di concorrenza o del database. Attendi i secondi indicati da `Retry-After` e riprova con attese crescenti e un limite.

Leggi questa voce in JSON