veil

Leggi lo stato privato di una prova

Riprendi una prova con il suo token state segreto.

GET/v1/links/{state}
Accesso
Serve un codice privato
Client
Client locale o server

Parametri#

NomePosizioneSignificato
stateObbligatorioPercorsoLo stato privato di 64 caratteri esadecimali restituito da start.

Esempi di richiesta#

cURL
curl -fsS 'https://veil.rip/v1/links/PROOF_STATE'

Risposta#

HTTP 200application/json

La sfida o il permesso verificato, la scadenza e le informazioni di subentro. Tratta risposta e state come privati.

CampoTipoSignificato
statestringStato privato della sessione di prova.
identityintegerNumero della scheda destinataria.
platformstringIdentificatore della piattaforma.
methodstringMetodo di prova.
statusstringpending, returned, verified, used o expired.
expiresAtstringScadenza della sessione.
subjectstring | nullIdentificatore normalizzato dell’account verificato.
displaystring | nullNome visualizzato verificato.
grantstring | nullGrant firmato monouso dopo la verifica, finché viene usato.
grantExpiresAtstring | nullScadenza del grant.
challengestring | nullIstruzioni pubbliche della prova.
claimedstring | nullAccount richiesto all’inizio, per i metodi che lo richiedono.
holderinteger | nullScheda attualmente titolare dell’account verificato.
waitDaysinteger | nullPeriodo di annullamento del subentro se un’altra scheda ne è titolare.
takeoverOpenboolean | nullIndica se un subentro è già aperto.

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.
Cache-Controlno-storeNon conservare le risposte private o temporanee in una cache condivisa.
Retry-Afterinteger seconds, on rate_limited or busyAttendi almeno questo intervallo prima di riprovare. Altri codici 429/503 non lo includono necessariamente.

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.

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.