Je suis assez nouveau ici chez SEOmoz, et l’un des projets sur lesquels je travaille est l’amélioration du contenu wiki de l’API Mozscape afin qu’il soit plus facile pour vous d’apprendre à accéder à toutes les données intéressantes disponibles via l’API Mozscape.
J’ai décidé de me lancer et d’essayer de comprendre. Mon plan initial n’était pas de tricher… c’est-à-dire de ne pas utiliser l’aide que j’ai en tant qu’employé et qui n’est pas disponible pour la plupart des utilisateurs d’API. Mais j’étais coincé, alors j’ai dû changer les règles… Vous avez entendu parler de Calvinball, n’est-ce pas ? J’ai créé une nouvelle règle selon laquelle je peux tricher, tant que je partage.
Rejoindre le jeu
Je m’étais déjà inscrit, puisque je travaille ici, mais cette partie n’est pas difficile. Si vous n’êtes pas déjà membre, rendez-vous sur cette page et inscrivez-vous pour un essai PRO gratuit ou inscrivez-vous à la communauté SEOmoz. Les deux vous donnent accès à la version gratuite de l’API Mozscape. Si vous aimez ce que vous voyez et souhaitez plus de demandes et un accès complet à l’API, les détails sur ce qui est disponible sont sur notre page de tarification de l’API.
Obtenir ma clé API SEOmoz secrète
Cette partie s’intégrerait parfaitement dans Calvin Ball… Je reçois une clé secrète ! Une fois connecté, la page Mise en route affiche la section Générer les informations d’identification de l’API. Je ne savais pas quoi mettre dans la section Votre ID d’accès, alors j’ai juste cliqué sur le bouton. Ensuite, j’ai dû accepter les conditions d’utilisation, et j’ai cliqué à nouveau dessus, et le tour est joué, j’ai mon ID d’accès et ma clé secrète.
Astuce #1: Vous ne saisissez pas votre ID d’accès, nous le générons. Lisez simplement nos conditions d’utilisation, cliquez sur la case qui les accepte, puis appuyez sur le gros Générer une clé secrète bouton (ou Régénérer, si vous l’avez déjà fait une fois).
Clés secrètes, signatures et authentification signée, Oh My !
Alors que j’envisageais de créer ma première demande d’API, je me suis retrouvé dans une impasse complète pour savoir comment authentifier ma demande. Mes problèmes étaient complètement auto-infligés, mais j’ai dû recourir à la tricherie pour les surmonter.
Triche #1 – Demander l’aide d’un gourou interne
J’avais commencé à lire les forums, et le problème numéro un sur les forums en ce moment est l’échec de l’authentification. Avant de commencer cet exercice, j’avais lu un message de forum qui disait que l’exemple d’authentification sur la page Mise en route était ancien et n’était plus la méthode recommandée pour faire les choses.
Cela m’a amené à ignorer ce qu’il disait réellement sur cette page et à essayer toutes sortes de choses pour créer moi-même un horodatage Unix et une signature valide, alors qu’il était assis devant moi tout le temps. Il a fallu parler aux gens ici pour me remettre sur la bonne voie.
Conseil n° 2 : Rappelez-vous que les forums représentent un moment dans le temps. Nous avons changé et réparé des choses, et ce que vous lisez sur les forums *pourrait* être obsolète. Nous avons remarqué que l’échantillon était mauvais, nous en avons parlé dans les forums, puis nous l’avons corrigé, ce qui signifie que le message du forum est désormais obsolète.
L’exemple de signature d’API valide est vraiment une signature d’API valide
Après les hésitations ci-dessus et ma première triche, j’ai réalisé que l’exemple de signature d’API valide est en fait une véritable signature d’API A#1 valide et me permet de faire une requête immédiatement.
J’ai donc pu utiliser l’exemple de demande sur la page de démarrage pour obtenir l’ID de membre, l’horodatage et la signature corrects dans le bon format.
Conseils 3 et 4 :
-
Si vous avez hésité après avoir obtenu votre clé secrète (comme je l’ai fait), vous devrez actualiser la page pour mettre à jour l’horodatage. L’horodatage sur l’échantillon n’est valide que pendant environ 5 minutes.
-
Votre signature doit être en base64 puis encodée en URL. C’est pourquoi la ligne de signature sur la page de démarrage est légèrement différente de la signature dans l’exemple de demande, qui a été encodée pour vous. Assurez-vous d’utiliser la chaîne Sample Request.
Métriques d’URL pour la victoire
Une fois que j’ai réalisé que l’authentification signée m’était fournie dans l’exemple de demande, il s’agissait simplement d’utiliser la documentation du wiki pour modifier la demande de l’URL et des mesures que je voulais. L’URL était simple ; Je viens de changer le site Web dans l’exemple de demande de “www.seomoz.org&2fblog” au site Web de ma coopérative alimentaire locale.
Ensuite, puisque l’exemple de demande utilise l’appel d’API url-metrics, j’ai cherché comment ajouter les métriques d’URL que je voulais sur la page wiki de l’API URL-Metrics. J’ai choisi ces métriques :
| Métrique | Indicateur de bit | Retour |
| Titre | 1 | Utah |
| URL | 4 | euh |
| Sous-domaine | 8 | ufq |
| Liens | 2048 | uid |
L’ajout de tous les drapeaux de bits pour ceux-ci me donne 2061. J’ai donc mis 2061 dans le paramètre Cols.
Astuce #2 – Connaissance préalable
Depuis que je suis ici depuis un peu plus d’un mois, j’avais déjà consulté la page de l’API URL-metrics et travaillé à l’amélioration du contenu. Je savais donc déjà comment utiliser le paramètre Cols et comment additionner les drapeaux de bits pour obtenir les métriques que je voulais.
Hobbes obtient les données de lien
Toutes les modifications ci-dessus apportées à la demande d’échantillon m’ont donné ma première requête de travail :
http://lsapi.seomoz.com/linkscape/url-metrics/www.snoislefoods.coop?Cols=2061&AccessID=
Je l’ai mis dans une nouvelle fenêtre de navigateur, j’ai appuyé sur Entrée et j’ai obtenu ma première réponse :
{“ufq”:”www.snoislefoods.coop/”,”uid”:864,”ut”:”Organic Produce Co op, Natural Food Cooperative | Sno-Isle Natural Foods Co-op Everett WA”,”uu”: “www.snoislefoods.coop/”}
Succès! J’ai utilisé le tableau sur la page de l’API URL-metrics (extrait ci-dessus) pour interpréter mes données de lien.
Changer les règles
Donc, c’est ce que j’ai appris qui pourrait vous être utile si vous débutez. Maintenant, la plupart du temps, vous n’allez pas accéder à vos données de lien en tapant une requête comme je l’ai fait dans la fenêtre du navigateur, mais j’espère que cela vous aidera à comprendre ce que sont toutes les pièces mobiles lors de la génération de vos requêtes par programme.
Après mon expérience avec cela, je travaillerai à l’amélioration de la page de démarrage, des pages du forum et de la documentation wiki pour vous aider à éviter les parties qui m’ont dérouté lors de ma première visite.
Si vous avez des suggestions, des histoires de réussite ou de très bons tricheurs, j’aimerais avoir de vos nouvelles. Envoyez un e-mail à api@seomoz.org.
Lisa – Mozstaff
