Leggi un riepilogo della scheda
Leggi i metadati correnti senza scaricare record firmati, prove o storia.
/v1/identities/{n}/summary- Accesso
- Pubblico; chiave API facoltativa
- Client
- Fetch dal browser supportato
Parametri#
| Nome | Posizione | Significato |
|---|---|---|
nObbligatorio | Percorso | Numero permanente positivo della scheda. |
Esempi di richiesta#
curl -fsS 'https://veil.pub/v1/identities/1/summary'const response = await fetch("https://veil.pub/v1/identities/1/summary");
const result = await response.json();Prova la richiesta#
Risposta#
n, url, name, initials, type, version, keys, orgs, badges, nameHidden e logo. Utile per etichette e menu.
| Campo | Tipo | Significato |
|---|---|---|
n | integer | Numero permanente della scheda. |
url | string | URL permanente con il numero della scheda. |
name | string | Nome visualizzato corrente; un nome nascosto diventa Card seguito dal numero. |
initials | string | Iniziali da mostrare in assenza di un’immagine. |
version | integer | Versione pubblicata corrente. |
keys | array<CardKey> | Tutte le chiavi dei dispositivi e di recupero, incluse quelle revocate. |
orgs | array<CardOrg> | Affiliazioni accettate alle organizzazioni di una persona. |
type | string | person o organization. |
badges | array<object> | Badge attivi firmati o derivati. |
logo | object | null | Tipo e URL dell’immagine; omesso in assenza di un’immagine visibile. |
alias | string | null | Alias corrente, che può cambiare. |
aliasUrl | string | null | Indirizzo dell’alias corrente. Usa n come identificatore permanente. |
nameHidden | boolean | Indica se lo staff nasconde il nome. |
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.
Chiave del dispositivo CardKey
| Campo | Tipo | Significato |
|---|---|---|
id | string | Etichetta del dispositivo mostrata sulla scheda. |
alg | string | Nome leggibile dell’algoritmo. |
fp | string | Chiave pubblica completa presente nel record firmato. |
ed25519 | string | Chiave Ed25519 o metà della chiave composita, in hex. |
since | string | Data di aggiunta della chiave. |
state | string | active, offline o revoked. Offline indica una chiave di recupero. |
revoked | string | null | Data di revoca, se revocata. |
role | string | Ruolo di firma assegnato alla chiave. |
addedIn | integer | Versione che ha aggiunto la chiave. |
revokedIn | integer | null | Versione che ha revocato la chiave. |
Affiliazione a un’organizzazione CardOrg
| Campo | Tipo | Significato |
|---|---|---|
n | integer | Numero permanente della scheda. |
url | string | URL permanente della scheda. |
name | string | Nome visualizzato, soggetto a moderazione. |
role | string | Ruolo dell’affiliazione accettata. |
since | string | Data e ora di inizio dell’affiliazione. |
nameHidden | boolean | Indica se lo staff nasconde il nome. |
logo | object | null | Tipo e URL dell’immagine, se disponibile. |
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. |
Retry-After | integer seconds, on rate_limited or busy | Attendi almeno questo intervallo prima di riprovare. Altri codici 429/503 non lo includono necessariamente. |
Cosa verificare#
Usa la scheda completa per una verifica o una decisione di autorizzazione.
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_parameter | Un campo del percorso, della query o del corpo manca, è malformato o fuori intervallo. Correggi il campo indicato in |
| 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. |
| 410 | erased | La scheda esisteva ed è stata cancellata o rimossa. La risposta contiene anche la ricevuta pubblica di cancellazione. Smetti di usare questa scheda come autorità corrente. Conserva soltanto la ricevuta pubblica se serve. |
Quando usi una chiave API facoltativa
| HTTP | Codice | Significato e cosa fare |
|---|---|---|
| 401 | invalid_api_key | La credenziale Bearer è malformata, sconosciuta, scaduta o revocata. Usa una chiave attiva. Per l’accesso pubblico anonimo, rimuovi del tutto |
| 403 | api_key_scope | La chiave API non ha il permesso read o verify, oppure l’endpoint non accetta chiavi Bearer. Usa il permesso corretto. Le modifiche alle schede e la gestione delle chiavi richiedono una firma del dispositivo. |
| 403 | api_key_suspended | Questa chiave API è sospesa. Chiedi allo staff di ripristinarla; un’altra chiave non rimuove la sospensione dell’account. |
| 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. |
Errori comuni delle richieste
| HTTP | Codice | Significato e cosa fare |
|---|---|---|
| 429 | rate_limited | È stato superato un limite anonimo, delle richieste firmate o della chiave API. Attendi almeno i secondi indicati da |
| 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 |