Utilisation de l'outil de test de l'API d'eBay

L'API d'eBay est un système complet qui vous permet d'appeler des données directement à partir des serveurs d'eBay. Elle diffère du flux, qui désigne un fichier autonome contenant des références à des objets mis en vente sur eBay. Le site Web du Programme des développeurs eBay contient un outil de test de l'API complet permettant de vérifier les résultats des appels à l'API avec un ou plusieurs paramètres disponibles. Cet outil peut être utilisé directement par les développeurs ou les partenaires qui souhaitent tester des appels de base à l'API avant de les intégrer à un site Web. Présentation détaillée de l'API

Outil de test de l'API

Configuration d'un appel à l'API

La partie gauche de la page de l'outil vous permet de définir le type d'appel à l'API que vous souhaitez effectuer ainsi que sa destination. Vous trouverez ci-dessous une description de l'objet et des conditions d'utilisation de chaque section.

Options Sandbox et Production L'option Sandbox permet d'utiliser des bases de données de test contenant des données ou des objets fictifs. L'option Production utilise les bases de données en ligne contenant les objets actuellement mis en vente sur eBay. Utilisez l'option Sandbox pour tester les appels destinés à eBay, tels que ceux de l'API Trading. Vous pourrez ensuite utiliser l'option Production pour activer l'appel une fois testé. Utilisez l'option Production pour extraire des informations, notamment pour rechercher des objets, des catégories et des vendeurs.

Jeu de clés Cette section sera renseignée automatiquement dès que vous aurez configuré vos clés de développeur à l'aide de votre page de compte de développeur.

Sélection d'une API Il existe de nombreuses API disponibles présentant chacune des fonctionnalités différentes. Les API Shopping et Finding permettent de rechercher des objets en vente. L'API Trading permet de mettre en vente et de vendre des objets, etc. Un guide complet des différentes API est disponible dans le centre de documentation. Dans le cadre de cet article, nous nous intéresserons principalement à l'API Finding.

Sélection d'un appel à l'API Vous pouvez effectuer différents types d'appels pour chaque API. Par exemple, dans l'API Finding, l'appel le plus utile et le plus courant est findItemsAdvanced, qui offre la flexibilité la plus élevée dans la recherche d'objets. Cependant, l'API Finding comporte d'autres appels, par exemple pour rechercher des objets par catégorie ou par nom de Boutique. Un guide complet présentant les différents appels disponibles et leurs fonctionnalités est disponible dans le centre de documentation.

Sélection d'un modèle Après avoir configuré votre type d'appel, vous pouvez créer un appel et modifier les critères de recherche de l'appel que vous avez défini. Les modèles permettent d'ajouter facilement des exemples de champs de critères de recherche dans le champ de requête situé à droite. Vous pouvez modifier ou supprimer ces critères à tout moment. Sélectionnez Full/Generic pour ajouter des champs vides dans la zone XML Request.  Sélectionnez Partial/Pre-Filled pour ajouter des exemples de champs de base déjà pré-remplis. Cela permet aux gens qui ne connaissent pas l'outil d'apprendre à l'utiliser pour faire des recherches. Pour afficher un exemple comprenant les paramètres de suivi ePN, sélectionnez l'option Full/Generic. Les paramètres apparaîtront dans les balises <affiliate>.

Sélection des variations d'appels/champs à inclure Le contenu du champ Select Call Variation/Fields to Include dépend du modèle sélectionné, mais encore une fois, il s'agit simplement d'une méthode rapide pour ajouter des champs de recherche dans la zone XML Request. Si vous avez choisi un modèle Full/Generic, vous pouvez ajouter uniquement les champs requis ou ajouter tous les champs possibles. Si vous choisissez d'ajouter tous les champs possibles, ceux-ci apparaîtront dans la zone XML Request située à droite. Vous pouvez alors parcourir la liste des champs et choisir ceux que vous souhaitez utiliser. Par exemple, vous pouvez décider de conserver la recherche par mots-clés et de supprimer la recherche par catégorie. Pour ce faire, sélectionnez la ligne <keywords>string</keywords> et ajoutez vos mots-clés en fonction de vos besoins. Sélectionnez ensuite la ligne <categoryId>string</categoryId> et supprimez-la. En utilisant de cette façon tous les champs possibles, vous pouvez afficher toutes les possibilités et exploiter pleinement un appel à l'API donnée.

Sélection d'une version de requête d'appel En règle générale, ce paramètre reste inchangé. Cependant, vous pouvez être amené à le modifier dans des circonstances très spécifiques, notamment lorsqu'une API a subi des modifications et causé des problèmes.

Sélection d'un code de site eBay compte de multiples sites Web destinés chacun à un usage particulier (par exemple, pour un pays spécifique ou pour eBay Auto aux Etats-Unis). Les objets mis en vente en France sont répertoriés dans le site français, ceux mis en vente en Allemagne dans le site allemand, etc. Les catégories des sites diffèrent également en fonction de la langue et des besoins du pays. Un appel à l'API ne peut être effectué que vers un seul site eBay. C'est pourquoi le code du site doit être spécifié. Si vous souhaitez effectuer un appel vers plusieurs sites, vous devez créer plusieurs appels à l'API.

Définition des valeurs de la requête

Une fois que vous avez configuré l'outil en fonction de l'appel à l'API que vous souhaitez créer, passez à la partie droite de la page de l'outil pour modifier les valeurs de requête de votre appel. Vous trouverez ci-dessous une description de chacune des sections disponibles :

Web Service URI (Endpoint) Cette section correspond à l'URL de l'API que vous utilisez. L'option Select an API renseigne automatiquement cette adresse, mais vous pouvez la modifier manuellement si vous le souhaitez.

HTTP Headers Comme précédemment, ces données sont automatiquement renseignées en fonction des choix effectués lors de la configuration de votre appel à l'API dans la partie de gauche. Vous pouvez les modifier manuellement si besoin.

XML Request Cette zone contient les données qui seront envoyées à l'API et déterminent les résultats attendus. Les paramètres de recherche sont contenus au sein de balises XML, par exemple : <entriesPerPage>2</entriesPerPage>. Les valeurs indiquées entre les balises (dans cet exemple, 2) correspondent aux valeurs que vous modifiez lorsque vous créez un appel. Pour vous familiariser avec l'outil, nous vous conseillons d'utiliser les exemples pré-remplis. Une documentation complète pour chaque paramètre est disponible dans le centre de documentation.

Affichage des résultats

Une fois que vous avez défini tous vos paramètres, soumettez votre recherche. Les résultats s'afficheront dans la zone Call Response au format XML. En voici un aperçu :

Si vous n'obtenez aucun résultat, modifiez votre appel pour étendre la recherche. Dès que vous êtes satisfait de votre appel, vous pouvez l'intégrer à un site Web (https://developer.ebay.com/quickstartguide/).

Exemple d'utilisation

Vous trouverez ci-dessous un exemple d'utilisation de l'outil pour obtenir une liste des shorts bleus immédiatement en vente au Royaume-Uni.

1. Sélectionnez l'environnement Production, car nous recherchons des objets mis en vente sur eBay.

2. Sélectionnez l'API Finding, car nous recherchons des objets.

3. Utilisez l'appel findItemsAdvanced pour pouvoir spécifier des paramètres avancés pour rechercher un type d'objet spécifique.

4. Définissez le modèle Full/Generic et ajoutez tous les champs possibles à l'appel. Cela vous permettra d'utiliser facilement tous les paramètres dont vous avez besoin et de supprimer les autres.

5. Choisissez UK comme code de site.

6. Sélectionnez la catégorie correspondant aux shorts.  Pour connaître le numéro de catégorie à utiliser, consultez la page (http://listings.ebay.co.uk/)  des catégories d'eBay. Vous pouvez également utiliser l'outil de catégorie CGMlab (http://ebay.cgmlab.co.uk/tool-categorytree.php) pour obtenir des détails sur les différentes catégories disponibles.

7. Définissez des filtres d'annonce pour inclure les enchères de type Achat immédiat, Prix fixe et Prix fixe Boutique eBay. Vous obtiendrez ainsi l'ensemble des objets pouvant être achetés immédiatement. Une liste complète des filtres d'annonce disponibles pour findItemsAdvanced est disponible sur le site (http://developer.ebay.com/DevZone/Finding/CallRef/types/ItemFilterType.html).

8. Définissez un filtre d'aspect pour rechercher uniquement les objets ayant comme couleur principale le bleu. Pour connaître les différents aspects possibles d'une catégorie donnée, consultez la page de cette catégorie (dans cet exemple, il s'agit de la page (http://clothes.shop.ebay.co.uk/Shorts-/15689/i.html?LH_LocatedIn=1&_armrs=1&_dmd=1&_mdo=Clothes-Shoes-Accessories&_mspp=&_pcats=1059%2C11450&_salic=3)). Pour obtenir des informations supplémentaires sur les filtres d'aspect, consultez la documentation sur les appels disponible à la page (http://developer.ebay.com/DevZone/Finding/CallRef/findItemsAdvanced.html#Request.aspectFilter).

9. Spécifiez vos paramètres de suivi ePN. L'identifiant du réseau pour eBay Partner Network est 9. Utilisez la balise du code de traçage <trackingId> comme identifiant de campagne.  La balise <geoTargeting> est destinée à une utilisation ultérieure. Vous pouvez lui attribuer la valeur 0.

10. Supprimez tous les champs non utilisés dans la zone XML Request. Etant donné que nous avons choisi d'inclure tous les champs possibles pour ajouter plus facilement ceux que nous voulions, de nombreux champs seront inutilisés. Ces champs peuvent avoir une incidence sur vos résultats et doivent donc être supprimés. Vous trouverez ci-dessous un exemple de l'appel complet obtenu :

11. Une fois l'appel effectué, vous recevrez une liste de résultats. Ces résultats contiennent les détails de l'appel et des objets renvoyés, ainsi que des messages d'erreur si l'appel a échoué. Vous pouvez utiliser ces données pour modifier les paramètres de configuration de l'appel, le renvoyer et essayer différentes solutions pour obtenir de meilleurs résultats.

Options d'implémentation

L'outil de test de l'API permet d'afficher facilement un appel à l'API et de modifier ses options pour obtenir l'appel qui répond le mieux à vos besoins. Un appel à l'API peut être implémenté de plusieurs manières et sous de nombreux format.  Des exemples d'appels à l'API Finding aux formats XML et URL standard sont disponibles à l'adresse suivante :

http://developer.ebay.com/DevZone/finding/CallRef/findItemsAdvanced.html#Samples

Pour obtenir des informations plus générales sur toutes les options de formats de requête et de réponse, consultez la page suivante :

http://developer.ebay.com/DevZone/finding/Concepts/MakingACall.html