veil

Leggi i badge di una scheda

Leggi i badge di una scheda e la storia di quelli rimossi.

GET/v1/identities/{n}/badges
Accesso
Pubblico; chiave API facoltativa
Client
Fetch dal browser supportato

Parametri#

NomePosizioneSignificato
nObbligatorioPercorsoNumero permanente positivo della scheda.

Esempi di richiesta#

cURL
curl -fsS 'https://veil.rip/v1/identities/1/badges'
javascript
const response = await fetch("https://veil.rip/v1/identities/1/badges");
const result = await response.json();

Prova la richiesta#

Risposta#

HTTP 200application/json

Le informazioni dei badge includono dichiarazione pubblica, stato corrente e riferimenti al registro quando presenti.

CampoTipoSignificato
nintegerNumero della scheda richiesta.
badgesarray<object>Badge firmati e derivati, inclusi quelli rimossi o scaduti. Leggi active, derived e source prima di mostrare un badge.

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.

Stato del badge ListedBadge
CampoTipoSignificato
idinteger | nullID del badge firmato, oppure null per un badge derivato.
badgestringIdentificatore del badge nel catalogo.
activebooleanIndica se questo badge è attualmente valido.
derivedbooleanIndica se deriva dall’affiliazione o dall’organizzazione dello staff.
sourcestringstatement, membership o staff_org.
iconstringURL dell’immagine del badge.
sincestringData e ora di inizio.
untilstring | nullScadenza, se limitato.
logIndexinteger | nullIndice nel registro dell’assegnazione o dell’affiliazione.
rolestring | nullRuolo di chi assegna o dell’affiliazione.
removedAtstring | nullData e ora di rimozione.
removalLogIndexinteger | nullIndice della rimozione nel registro.

Intestazioni della risposta#

IntestazioneValoreSignificato
Content-Typeapplication/jsonUsa il tipo dichiarato per scegliere come leggere il corpo.
DateHTTP dateOra del server. Confrontala con il tuo orologio per firmare le richieste.
Retry-Afterinteger seconds, on rate_limited or busyAttendi almeno questo intervallo prima di riprovare. Altri codici 429/503 non lo includono necessariamente.

Cosa verificare#

Controlla le dichiarazioni firmate e gli impegni nel registro prima di usare un badge come condizione 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

HTTPCodiceSignificato e cosa fare
400invalid_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.

404not_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.

410erased

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
HTTPCodiceSignificato e cosa fare
401invalid_api_key

La credenziale Bearer è malformata, sconosciuta, scaduta o revocata.

Usa una chiave attiva. Per l’accesso pubblico anonimo, rimuovi del tutto Authorization. Credenziali non valide non attivano automaticamente l’accesso anonimo.

403api_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.

403api_key_suspended

Questa chiave API è sospesa.

Chiedi allo staff di ripristinarla; un’altra chiave non rimuove la sospensione dell’account.

403developer_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
HTTPCodiceSignificato e cosa fare
429rate_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.

500internal_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.

503busy

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.