Les anciennes URL d’export
Avant l’existence de l’API, les résultats se téléchargeaient en ajoutant
?export= et une clé à une URL de recherche ordinaire. Ces URL
fonctionnent toujours, exactement comme avant, à l’octet près. Elles ne
disparaîtront pas.
https://publicwww.com/websites/%22angular.min.js%22/?export=csv&key=YOUR_KEY
export= | Renvoie |
|---|---|
urls | Une URL par ligne. |
csv | domain;rank |
csvu | url;rank |
csvsnippets | domain;rank;snippet |
csvsnippetsu | url;rank;snippet |
cluster | Enregistre les résultats sous forme de cluster au lieu de les télécharger. |
&delimiterColumns= et &delimiterSnippets=
modifient les séparateurs, et
https://publicwww.com/profile/api_status.xml renvoie
l’utilisation du jour en XML. Transmettez la clé dans l’en-tête
Authorization: Bearer <your api key> ; l’ancienne forme
?key= fonctionne encore mais est obsolète, car une clé placée dans
l’adresse finit dans l’historique du navigateur et les journaux des serveurs.
Pourquoi elles sont à part
Ces URL constituent la couche de compatibilité, et c’est en les gardant ainsi que l’API peut rester une API moderne classique. Leur sortie est verrouillée à l’octet près par un test exécuté à chaque modification : un script écrit il y a des années continue donc d’analyser ce qu’il a toujours analysé. Rien de nouveau ne leur est ajouté.
Migrer un script
Les équivalents les plus proches :
| Ancien | Nouveau |
|---|---|
?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 requête dans le chemin de l’URL | query=, ou un corps JSON |
api_status.xml | /v1/account |
Les colonnes correspondent : en général, l’analyseur n’a pas à changer. Ce qui change en vaut la peine :
- Une clé invalide donne un
401avec un corps JSON, et non un200contenant les motsWrong API keyà la place des lignes. - Des requêtes trop rapides reçoivent immédiatement un
429avec unRetry-After, au lieu d’une connexion maintenue ouverte jusqu’à une demi-minute puis refusée. - Un quota épuisé est une erreur. Avec les anciennes URL, vous repassez discrètement aux limites de l’offre gratuite et recevez moins de lignes, sans que rien dans la réponse ne le signale.
- Une réponse raccourcie est signalée -
X-Truncated. - La pagination : un client n’a pas besoin de tout télécharger pour consulter les vingt premiers résultats.