Environnement de test de l'API partenaire de vente

L'API Selling Partner (SP-API) fournit deux environnements sandbox que vous pouvez utiliser pour tester vos applications sans affecter les données de production ni déclencher d'événements réels. Le Sandbox statique SP-API utilise la correspondance de modèles pour renvoyer des réponses statiques et fictives. Le Sandbox dynamique SP-API achemine les demandes vers un backend sandbox qui renvoie 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 sandbox 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 sandbox. Pour plus d'informations sur les opérations restreintes pour lesquelles vous avez besoin d'un RDT, reportez-vous au Guide de cas d'utilisation de l'API Tokens.

Sandbox statique SP-API

Effectuer des appels sandbox vers le sandbox statique SP-API (sandbox statique) revient à passer des appels de production, sauf que vous dirigez les appels vers Points de terminaison de l'API Selling Partner. L'appel des points de terminaison du sandbox renvoie des réponses statiques et fictives pour toutes les API SP. Vous pouvez faire référence à ces réponses fictives dans le fichier JSON du modèle Swagger correspondant à l'API que vous souhaitez appeler. Pour plus d'informations, reportez-vous à Effectuer un appel sandbox statique.

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.

Pour effectuer un appel sandbox statique, procédez comme suit :

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

1. Accédez au page d'accueil.

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.

Sandbox dynamique SP-API

Les appels vers le sandbox dynamique SP-API (sandbox dynamique) sont identiques aux appels de production, sauf que vous dirigez les appels vers le Points de terminaison de l'API Selling Partner. Les appels sandbox dynamiques sont transmis par proxy (c'est-à-dire transférés) à un backend sandbox, qui renvoie une réponse appropriée en fonction des paramètres de la demande. Comme vous n'êtes pas limité à la correspondance exacte des modèles, vous pouvez faire des demandes et recevoir des réponses qui peuvent contenir un état et réagir aux entrées. Par exemple, vous souhaiterez peut-être vérifier les frais d'expédition pour différentes adresses de livraison. Ce que vous pouvez faire est limité uniquement par les fonctionnalités prises en charge par le backend sandbox fourni pour cette section d'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.

Pour effectuer un appel sandbox dynamique, procédez comme suit :

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

1. Accédez au page d'accueil.

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 :

   JSON

   "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 du sandbox SP-API

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