Leggi una voce della documentazione
Leggi una guida o un contratto di endpoint con gli esempi.
/v1/integrations/{id}- Accesso
- Pubblico; chiave API facoltativa
- Client
- Fetch dal browser supportato
Parametri#
| Nome | Posizione | Significato |
|---|---|---|
idObbligatorio | Percorso | ID della voce dal catalogo. |
lang | Query | en oppure it. La lingua predefinita è l’inglese. |
Esempi di richiesta#
curl -fsS 'https://veil.rip/v1/integrations/lookup'const response = await fetch("https://veil.rip/v1/integrations/lookup");
const result = await response.json();Prova la richiesta#
Risposta#
Descrizione localizzata, parametri, note sulla risposta e blocchi di esempio, con la revisione del catalogo.
| Campo | Tipo | Significato |
|---|---|---|
revision | string | Revisione del catalogo. |
language | string | en o it. |
entry | object | Riferimento completo tradotto. Gli endpoint includono responses, responseObjects, responseHeaders, errorDetails e i parametri e gli esempi delle richieste esistenti. |
Non modificato. Riusa la rappresentazione salvata con questo ETag; non c’è corpo nella risposta.
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. |
ETag | opaque validator | Rimandalo in If-None-Match. Revisione e lingua corrispondenti restituiscono 304 senza corpo. |
Cache-Control | public, max-age=300 | Il riferimento può restare in cache per cinque minuti. |
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_parameter | Un campo del percorso, della query o del corpo manca, è malformato o fuori intervallo. Correggi il campo indicato in |
| 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. |
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 |
| 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 | rate_limited | È stato superato un limite anonimo, delle richieste firmate o della chiave API. Attendi almeno i secondi indicati da |
| 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 |