veil

Leggi i ruoli pubblici di Veil

Identifica l’organizzazione ufficiale di Veil e i poteri di ogni ruolo dello staff.

GET/v1/staff
Accesso
Pubblico; chiave API facoltativa
Client
Fetch dal browser supportato

Esempi di richiesta#

cURL
curl -fsS 'https://veil.pub/v1/staff'
javascript
const response = await fetch("https://veil.pub/v1/staff");
const result = await response.json();

Prova la richiesta#

Risposta#

HTTP 200application/json

org indica l’organizzazione. roles associa ogni ruolo alle azioni ammesse. I membri sono sulla scheda dell’organizzazione.

CampoTipoSignificato
orgOrgRef | nullOrganizzazione dello staff di Veil, se configurata.
rolesobjectMappa dei ruoli e degli identificatori delle azioni consentite.

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.

CampoTipoSignificato
nintegerNumero permanente della scheda.
urlstringURL permanente della scheda.
namestringNome visualizzato corrente.
tokenstringPseudonimo stabile nel registro pubblico in base64url.
nameHiddenbooleanIndica se lo staff nasconde il nome.
logoobject | nullTipo e URL dell’immagine.

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.

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

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.