Inizia la prova di un account

Inizia una prova OAuth, email, dominio o Fediverso per una scheda che puoi gestire.

POST/v1/links/start

Accesso: Richiesta firmata
Client: Client locale o server

Corpo JSON#

Nome	Posizione	Significato
`identity`Obbligatorio	JSON	Numero permanente della scheda.
`platform`Obbligatorio	JSON	ID di una piattaforma supportata da /v1/platforms.
`subject`	JSON	Obbligatorio per email, dominio e Fediverso. OAuth lo riceve dalla piattaforma.
`method`	JSON	Metodo facoltativo. Un dominio supporta dns_txt e well_known.

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/start"

Risposta#

HTTP 201application/json

201 con state, method, expiresAt e challenge. Mantieni state privato. Iniziare o completare una prova non aggiunge ancora l’account alla scheda.

Campo	Tipo	Significato
`state`	`string`	Stato segreto di 64 caratteri. Mantienilo privato.
`identity`	`integer`	Numero della scheda destinataria.
`platform`	`string`	Identificatore della piattaforma.
`method`	`string`	Metodo di prova scelto.
`expiresAt`	`string`	Scadenza della sessione di prova.
`challenge`	`object`	Istruzioni specifiche del metodo, per esempio URL OAuth, record DNS o link sul profilo.

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.

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	`identity_banned`	La scheda che agisce è sospesa dallo staff di Veil. Attendi la fine della restrizione o chiedi allo staff di riesaminarla.
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.
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	`not_for_organizations`	Questo metodo prova un account personale e non è disponibile per le organizzazioni. Scegli un metodo di prova per organizzazioni supportato da /v1/platforms.
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.
503	`mail_unavailable`	Non è stato possibile inviare l’email di verifica. Riprova ad avviare la prova email tra qualche minuto.
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

Corpo JSON#

Esempi di richiesta#

Risposta#

Intestazioni della risposta#

Errori#

Pagine correlate#