I vecchi URL di esportazione
Prima che esistesse un'API, i risultati si scaricavano aggiungendo
?export= e una chiave a un normale URL di ricerca. Quegli URL
funzionano ancora, esattamente come hanno sempre fatto, byte per byte.
Non verranno eliminati.
https://publicwww.com/websites/%22angular.min.js%22/?export=csv&key=YOUR_KEY
export= | Restituisce |
|---|---|
urls | Un URL per riga. |
csv | domain;rank |
csvu | url;rank |
csvsnippets | domain;rank;snippet |
csvsnippetsu | url;rank;snippet |
cluster | Salva i risultati come cluster invece di scaricarli. |
&delimiterColumns= e &delimiterSnippets=
cambiano i separatori, e
https://publicwww.com/profile/api_status.xml riporta l'utilizzo
del giorno in XML. Passa la chiave nell'header
Authorization: Bearer <your api key>; la vecchia forma
?key= funziona ancora ma è deprecata, perché una chiave
nell'indirizzo finisce nella cronologia del browser e nei log del server.
Perché sono separati
Questi URL sono il livello di compatibilità, ed è proprio tenerli così che permette all'API di essere un'API moderna e normale. Il loro output è fissato byte per byte da un test che viene eseguito a ogni modifica, così uno script scritto anni fa continua a leggere ciò che ha sempre letto. Non viene aggiunto nulla di nuovo.
Spostare uno script
Gli equivalenti più vicini:
| Vecchio | Nuovo |
|---|---|
?export=csv | format=csv |
?export=csvu | format=csv&columns=url,rank |
?export=urls | format=txt |
?export=csvsnippets | format=csv&snippets=1 |
?export=csvsnippetsu | format=csv&columns=url,rank,snippets&snippets=1 |
&key= | Authorization: Bearer |
&delimiterColumns= | delimiter= |
| la query nel percorso dell'URL | query=, oppure un corpo JSON |
api_status.xml | /v1/account |
Le colonne coincidono, quindi di solito il parser non cambia. Ciò che cambia vale la pena di averlo:
- Una chiave errata dà
401con un corpo JSON, non200con le paroleWrong API keyal posto delle righe. - Le richieste troppo rapide ricevono subito
429con unRetry-After, invece di tenere aperta la connessione fino a mezzo minuto per poi rifiutarla. - Una quota esaurita è un errore. Sui vecchi URL ti riporta silenziosamente ai limiti del piano gratuito e restituisce meno righe, senza che la risposta lo segnali.
- Una risposta accorciata viene segnalata:
X-Truncated. - La paginazione, così un client non deve scaricare tutto per guardare i primi venti risultati.