Environnement de test de l'API partenaire de vente

Utilisez le sandbox SP-API pour effectuer des appels de test.

L'API partenaire de vente fournit deux environnements de test qui vous permettent de tester vos applications sans affecter les données de production ni déclencher d'événements réels. L'environnement de test statique de l'API partenaire de vente utilise la correspondance de modèles pour afficher des réponses statiques simulées tandis que l'environnement de test dynamique achemine les demandes vers un environnement backend qui peut renvoyer des réponses réalistes en fonction des paramètres de la demande.

🚧

Important

les environnements de test sont conçus pour tester les fonctionnalités et non l'évolutivité. Les appels vers des terminaux d'environnement de test sont soumis aux limites suivantes : débit = 5 requêtes par seconde ; rafale = 15. Pour plus d'informations sur la limitation, reportez-vous aux Plans d'utilisation et limites de débit dans l'API partenaire de vente.

Si vous utilisez un environnement de test SP-API pour tester un appel qui nécessite un jeton de données restreint (RDT), vous devez obtenir le RDT depuis l'environnement de production et le transmettre à votre appel test. Vous trouverez plus d'informations sur les opérations restreintes pour lesquelles vous aurez besoin d'un RDT ici.

Contenu

L'environnement de test statique de l'API partenaire de vente

Procéder à des appels de test vers l'environnement de test statique de l'API partenaire de vente revient à passer des appels de production, sauf que vous dirigez ces appels vers des points de terminaison de l'environnement de test de l'API partenaire de vente. Appeler des points de terminaison de l'environnement de test renvoie des réponses statiques et simulées pour toutes les API partenaire de vente. Vous pouvez vous référer à ces réponses simulées dans le fichier JSON du modèle Swagger pour l'API que vous souhaitez appeler. Pour plus d'informations, reportez-vous à la section Comment appeler l'environnement de test statique de l'API partenaire de vente.

L'environnement de test statique de l'API partenaire de vente fonctionne comme de nombreux outils de simulation, dans la mesure où il utilise la correspondance de modèles pour afficher une réponse spécifique lorsque les paramètres indiqués sont réunis. Un développeur reçoit une réponse définie dans l'un des objets suivants lorsqu'il envoie une demande incluant les paramètres indiqués :

Objets JSON d'environnement de test statique


"x-amzn-api-sandbox":
{
  "static": [
    {
      "request":
      {
        "parameters": 
        {
          …
        }
      },
      "response":
      {
        …
      }
    }
  ]
}

Notez que bien que ces objets contiennent les paramètres nécessaires pour correspondre à une réponse de simulation, ils ne contiennent pas nécessairement tous les paramètres nécessaires à une réponse satisfaisante. Pour obtenir une réponse satisfaisante, assurez-vous que votre demande est valide et qu'elle inclut tous les paramètres requis tels que définis dans le modèle Swagger correspondant.

Comment appeler l'environnement de test statique de l'API partenaire de vente

Étape 1 : Vérifier les paramètres de demande dans le fichier JSON

  1. Accédez à la page Documentation.

  2. Dans le volet de navigation de gauche, localisez le dossier de l'API pour laquelle vous souhaitez effectuer un appel test.

  3. Cliquez sur le fichier JSON du modèle Swagger pour l'API de votre choix.

    Le code JSON s'affiche.

  4. Recherchez le code d'un objet x-amzn-api-sandbox contenant un tableau "static".

Les objets JSON de test statique contiennent des exemples de requêtes et de réponses pour les appels de test statiques à l'opération d'API dans laquelle ils apparaissent. Si l'exemple de demande contient des paramètres, utilisez-les à l'étape suivante.

Étape 2 : Effectuer un appel test statique à une API

Effectuez un appel test statique à une API de la même manière que vous le feriez pour un appel de production, en tenant compte des différences suivantes :

  1. Incluez les paramètres de l'Étape 1 : Vérifier les paramètres de demande dans le fichier JSON lors de votre appel. Si l'API nécessite des paramètres supplémentaires, veillez à inclure ces paramètres dans votre appel.

  2. Dirigez votre appel vers l'un des Points de terminaison de l'environnement de test de l'API partenaire de vente.

    Vous devriez recevoir une réponse correspondant à l'objet de charge utile contenu dans l'objet JSON de test statique de l'Étape 1.

L'environnement de test dynamique de l'API partenaire de vente

Les appels tests dynamiques à l'API partenaire de vente sont identiques aux appels de production, sauf que vous dirigez les appels vers des Points de terminaison de l'environnement de test de l'API partenaire de vente. Les appels tests dynamiques sont transmis par proxy (c'est-à-dire transférés) vers un environnement de test backend, qui renvoie une réponse appropriée en fonction des paramètres de la demande. Étant donné que vous n'êtes pas obligé de suivre exactement un modèle, vous pouvez formuler des demandes et recevoir des réponses qui peuvent avoir un état et réagir aux entrées. Par exemple, vous pouvez vérifier les frais d'expédition pour différentes adresses de livraison. Notez que vos seules limites sont celles des fonctionnalités prises en charge par l'environnement de test backend fourni pour cette section API.

Vous pouvez déterminer quelles opérations prennent en charge les appels tests dynamiques en consultant le fichier JSON du modèle Swagger pour l'API que vous souhaitez appeler. Une opération prend en charge les appels tests dynamiques si elle inclut l'objet suivant :

"x-amzn-api-sandbox": { "dynamic": {} }

L'objet est accessible au niveau de l'opération ou du chemin. Lorsque c'est au niveau du chemin, toutes les opérations au sein du chemin peuvent effectuer des appels vers l'environnement de test dynamique.

Comment appeler l'environnement de test dynamique de l'API partenaire de vente

Étape 1 : Vérifier les opérations qui prennent en charge les appels tests dynamiques dans le fichier JSON

  1. Accédez à la page Documentation.

  2. Dans le volet de navigation de gauche, localisez le dossier de l'API pour laquelle vous souhaitez effectuer un appel test.

  3. Cliquez sur le fichier JSON du modèle Swagger pour l'API de votre choix.

    Le code JSON s'affiche.

  4. Recherchez le code pour :

"x-amzn-api-sandbox": { "dynamic": {} }

Si l'opération contient l'objet au niveau du chemin ou de l'opération, l'environnement de test dynamique est pris en charge.

Étape 2 : Effectuer un appel test dynamique à une API

Passez un appel test dynamique à une API de la même manière que vous le feriez pour un appel de production, sauf que vous dirigerez votre appel vers l'un des Points de terminaison de l'environnement de test de l'API partenaire de vente.

Opérations réservées à l'environnement de test

Les environnements de test prennent en charge des API facultatives qui sont uniquement en mode environnement de test et qui peuvent seulement réussir lorsqu'elles sont dirigées vers l'un des Points de terminaison de l'environnement de test de l'API partenaire de vente. Pour déterminer quelles opérations sont uniquement en mode environnement de test, consultez le fichier JSON du modèle Swagger pour la section API. Une opération uniquement en mode environnement de test contient "x-amzn-api-sandbox-only": true soit au niveau de l'opération, soit au niveau du chemin. Lorsque c'est au niveau du chemin, toutes les opérations de ce dernier sont en mode environnement de test uniquement.

Les opérations uniquement en mode environnement de test complètent l'API de production afin de vous permettre de créer des workflows de test impossibles à l'aide des opérations de l'API de production. Par exemple, vous pouvez avoir un cas d'utilisation dans lequel un élément de données est instancié via l'interface utilisateur, mais pas via une API. À des fins de test uniquement, une API uniquement en mode environnement de test peut être fournie pour créer l'élément de données permettant de créer des flux de travail de test plus complets.

Points de terminaison de test de l'API partenaire de vente

L'API partenaire de vente possède des points de terminaison de test pour les régions de vente d'Amérique du Nord, d'Europe et d'Extrême-Orient.

Région de ventePoint de terminaisonRégion AWS
Amérique du Nord (sites de ventes au Canada, aux États-Unis, au Mexique et au Brésil)https://sandbox.sellingpartnerapi-na.amazon.comus-east-1
Europe (sites de ventes en Espagne, au Royaume-Uni, en France, aux Pays-Bas, en Allemagne, en Italie, en Suède, en Pologne, en Égypte, en Turquie, aux Émirats arabes unis et en Inde)https://sandbox.sellingpartnerapi-eu.amazon.comeu-west-1
Extrême-Orient (sites de vente à Singapour, en Australie et au Japon)https://sandbox.sellingpartnerapi-fe.amazon.comus-west-2

Cette page vous a-t-elle été utile ?