veil

Leggi la sitemap

Le pagine e le schede pubbliche che un motore di ricerca può elencare, ogni scheda al suo indirizzo canonico.

GET/sitemap.xml
Accesso
Accesso pubblico
Client
Client locale o server

Altri indirizzi#

  • /sitemaps/pages.xml
  • /sitemaps/{file}

Esempi di richiesta#

cURL
curl -fsS 'https://veil.rip/sitemap.xml'

Risposta#

HTTP 200application/xml

Un urlset di sitemaps.org: la pagina d’ingresso, /verify, /canary, ogni pagina di /docs e ogni scheda pubblica con lastmod dalla versione corrente. Oltre 50.000 indirizzi è un indice di /sitemaps/pages.xml e /sitemaps/cards-<k>.xml.

Intestazioni della risposta#

IntestazioneValoreSignificato
Content-Typeapplication/xmlUsa il tipo dichiarato per scegliere come leggere il corpo.
DateHTTP dateOra del server. Confrontala con il tuo orologio per firmare le richieste.
Cache-Controlpublic, max-age=600Una sitemap può restare in cache dieci minuti, quanto la tiene il server.
Retry-Afterinteger seconds, on rate_limited or busyAttendi almeno questo intervallo prima di riprovare. Altri codici 429/503 non lo includono necessariamente.

Note d’uso#

  • Le schede sospese, rimosse, chiuse o con il nome nascosto non compaiono mai. Ogni file si ricostruisce al più ogni 10 minuti; le letture contano su un limite di 30 al minuto per IP.

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

Quando usi una chiave API facoltativa
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.

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.