Leggi il percorso di una voce dello stato

Ottieni il percorso di Merkle sparso di una voce, o del posto vuoto, per aggiornare la radice di un insieme.

GET/v1/identities/{n}/sets/{set}/path

Accesso: Pubblico; chiave API facoltativa
Client: Fetch dal browser supportato

Parametri#

Nome	Posizione	Significato
`n`Obbligatorio	Percorso	Numero permanente positivo della scheda.
`set`Obbligatorio	Percorso	keys, links, orgs o members.
`key`Obbligatorio	Query	La chiave della voce: una chiave pubblica, piattaforma e account separati da un a capo, o il token di una scheda.

Esempi di richiesta#

cURL

curl -fsS 'https://veil.rip/v1/identities/1/sets/keys/path?key=0000000000000000000000000000000000000000000000000000000000000000'

javascript

const response = await fetch("https://veil.rip/v1/identities/1/sets/keys/path?key=0000000000000000000000000000000000000000000000000000000000000000");
const result = await response.json();

Risposta#

HTTP 200application/json

item è la voce o null; proof la porta, o porta la foglia vuota, fino a root.

Campo	Tipo	Significato
`n`	`integer`	Numero permanente della scheda.
`version`	`integer`	La versione corrente.
`set`	`string`	L’insieme letto.
`key`	`string`	La chiave chiesta.
`position`	`string`	La posizione della voce in base64 standard.
`item`	`object \| null`	La voce in vigore, o null.
`proof`	`object`	bitmap e siblings del percorso.
`root`	`string`	La radice dell’insieme della versione corrente.

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#

Risali con la prova dalla foglia della voce (o dalla foglia vuota) e confronta con root; la stessa prova con la nuova foglia dà la nuova radice.

Note d’uso#

Solo su un registro in formato 2 (GET /v1/log dice format 2). Un registro in formato 1 risponde 400 wrong_format.

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 `error.message` prima di inviare di nuovo.
400	`wrong_format`	La richiesta o la lettura appartiene all’altro formato del registro di questo server: un record v1 su un registro in formato 2, o una lettura del formato 2 su un registro in formato 1. Leggi `format` in GET /v1/log (assente vuol dire 1) e manda la forma di quel formato.
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 `Authorization`. Credenziali non valide non attivano automaticamente l’accesso anonimo.
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

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 `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.

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