Completa la prova di un account

Completa una prova con la stessa chiave che l’ha iniziata.

POST/v1/links/{state}/complete

Accesso: Richiesta firmata
Client: Client locale o server

Parametri#

Nome	Posizione	Significato
`state`Obbligatorio	Percorso	Lo stato privato di 64 caratteri esadecimali restituito da start.

Corpo JSON#

Nome	Posizione	Significato
`code`	JSON	Codice di conferma per le prove email.
`returnCode`	JSON	Codice di ritorno usa e getta della callback OAuth.

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/links/PROOF_STATE/complete"

Risposta#

HTTP 200application/json

Lo stato della prova, con un permesso quando verificata. Includi il permesso in una nuova versione firmata per pubblicare il collegamento.

Campo	Tipo	Significato
`state`	`string`	Stato privato della sessione di prova.
`identity`	`integer`	Numero della scheda destinataria.
`platform`	`string`	Identificatore della piattaforma.
`method`	`string`	Metodo di prova.
`status`	`string`	pending, returned, verified, used o expired.
`expiresAt`	`string`	Scadenza della sessione.
`subject`	`string \| null`	Identificatore normalizzato dell’account verificato.
`display`	`string \| null`	Nome visualizzato verificato.
`grant`	`string \| null`	Grant firmato monouso dopo la verifica, finché viene usato.
`grantExpiresAt`	`string \| null`	Scadenza del grant.
`challenge`	`string \| null`	Istruzioni pubbliche della prova.
`claimed`	`string \| null`	Account richiesto all’inizio, per i metodi che lo richiedono.
`holder`	`integer \| null`	Scheda attualmente titolare dell’account verificato.
`waitDays`	`integer \| null`	Periodo di annullamento del subentro se un’altra scheda ne è titolare.
`takeoverOpen`	`boolean \| null`	Indica se un subentro è già aperto.

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.

Note d’uso#

DNS e Fediverso usano soltanto nonce e timestamp nel corpo. Il server controlla il record o il link di ritorno.

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	`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	`proof_pending`	L’accesso OAuth non è ancora tornato. Completa l’accesso al provider nel browser che lo ha avviato.
410	`proof_expired`	La sessione temporanea di prova dell’account è scaduta. Avvia una nuova sessione di collegamento.
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.
422	`proof_failed`	Il provider, il codice o la prova pubblicata non hanno superato la verifica. Leggi `error.message`, correggi la prova e riprova mentre la sessione è valida.
422	`proof_not_found`	Il record DNS, il file sul sito o il collegamento sul profilo richiesti non sono ancora visibili. Pubblica la prova esatta e attendi la propagazione prima di ricontrollare.
429	`too_many_attempts`	Questa sessione di prova ha superato il numero di tentativi con codice errato. Avvia una nuova sessione di prova. Questo codice è distinto da `rate_limited` per le quote.
503	`provider_not_configured`	Il provider di prova scelto non è disponibile su questo server. Leggi /v1/platforms per i metodi disponibili.

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