Entorno aislado de la API del colaborador comercial

Utilice el entorno limitado de SP-API para realizar llamadas de prueba.

La API del colaborador comercial proporciona dos entornos aislados que te permiten probar tus aplicaciones sin afectar a los datos de producción ni desencadenar eventos reales. El entorno aislado estático de la API del colaborador comercial utiliza la concordancia de patrones para devolver respuestas estáticas simuladas. El entorno aislado dinámico de la API del colaborador comercial reenvía las solicitudes a un backend de entorno aislado que puede devolver respuestas realistas basadas en los parámetros de la solicitud.

🚧

Importante

The sandbox environments are for testing functionality, not scalability testing. Calls to sandbox endpoints are subject to these throttling limits: rate = five requests per second; burst = 15. For more information about throttling refer to Usage Plans and Rate Limits in the Selling Partner API.

If you are using an SP-API sandbox environment to test a call that requires a Restricted Data Token (RDT), you must get the RDT from the production environment and pass it to your sandbox call. More information about restricted operations for which you will need an RDT can be found here.

Contenido

El entorno aislado estático de la API del colaborador comercial

Making sandbox calls to the Selling Partner API static sandbox (static sandbox) is identical to making production calls except you direct the calls to the Selling Partner API sandbox endpoints. Calling the sandbox endpoints returns static, mocked responses for all Selling Partner APIs. You can refer to these mocked responses in the Swagger model JSON file for the API that you want to call. For more information, refer to How to make a static sandbox call to the Selling Partner API.

El entorno aislado estático de la API del colaborador comercial funciona como muchos marcos de simulación en el sentido de que utiliza la concordancia de patrones para devolver una respuesta especificada cuando están presentes los parámetros especificados. Un desarrollador recibe una respuesta definida en uno de los siguientes objetos cuando envía una solicitud que incluye los parámetros especificados:

Objetos JSON de entornos aislados estáticos


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

Aunque estos objetos contienen los parámetros necesarios para obtener una respuesta simulada, no contienen necesariamente todos los parámetros necesarios para obtener una respuesta correcta. Para obtener una respuesta satisfactoria, asegúrate de que tu solicitud es válida e incluye todos los parámetros necesarios definidos en el modelo Swagger correspondiente.

Cómo realizar una llamada de entorno aislado estático a la API del colaborador comercial

Paso 1. Comprobar los parámetros de solicitud en el archivo JSON

  1. Go to the Documentation page.

  2. En el panel de navegación izquierdo, localiza la carpeta de la API para la que deseas realizar una llamada de entorno aislado.

  3. Selecciona el archivo JSON del modelo Swagger de la API deseada.

    Aparecerá el código JSON.

  4. Busca el código de un objeto x-amzn-api-sandbox que contenga una matriz "static".

The static sandbox JSON objects will contain request and response examples for static sandbox calls to the API operation in which they appear. If the request example contains parameters, use them in the following step.

Paso 2. Realizar una llamada de entorno aislado estático a una API

Realiza una llamada de entorno aislado estático a una API de la misma forma que harías una llamada de producción, con estas diferencias:

  1. Include the parameters from Step 1. Check the JSON file for request parameters in your call. If the API requires parameters in addition to those, be sure to also include those required parameters in your call.

  2. Direct your call to one of the Selling Partner API sandbox endpoints.

    Deberías recibir una respuesta que corresponda al objeto de carga útil contenido en el objeto JSON del entorno estático del paso 1.

El entorno aislado dinámico de la API del colaborador comercial

Making calls to the Selling Partner API dynamic sandbox (dynamic sandbox) is identical to making production calls except you direct the calls to the Selling Partner API sandbox endpoints. Dynamic sandbox calls are proxied (that is, forwarded) to a sandbox backend, which returns an appropriate response given the request parameters. Because you are not limited to exact pattern matching, you can make requests and receive responses that are potentially stateful and react to input. For example, you might want to verify the shipping charges for different ship-to addresses. What you can do is limited only by the capabilities supported by the sandbox backend provided for that API section.

Puedes determinar qué operaciones admiten llamadas al entorno aislado dinámico al revisar el JSON del modelo Swagger de la API a la que quieres llamar. Una operación admite llamadas al entorno aislado dinámico si la operación incluye el siguiente objeto:

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

El objeto puede encontrarse a nivel de operación o de ruta. Cuando se encuentra a nivel de ruta, todas las operaciones dentro de la ruta pueden realizar llamadas al entorno aislado dinámico.

Cómo realizar una llamada de entorno aislado dinámico a la API del colaborador comercial

Paso 1. Comprobar en el archivo JSON las operaciones que permiten realizar llamadas de entorno aislado dinámico

  1. Go to the Documentation page.

  2. En el panel de navegación izquierdo, localiza la carpeta de la API para la que deseas realizar una llamada de entorno aislado.

  3. Selecciona el archivo JSON del modelo Swagger de la API deseada.

    Aparecerá el código JSON.

  4. Busca lo siguiente en el código:

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

Si la operación contiene el objeto a nivel de ruta u operación, es compatible con el entorno aislado dinámico.

Paso 2. Realizar una llamada de entorno aislado dinámico a una API

Make a dynamic sandbox call to an API in the same way you would make a production call, except direct your call to one of the Selling Partner API sandbox endpoints.

Operaciones exclusivas del entorno aislado

The sandbox environments support optional APIs that are sandbox-only and can succeed only when directed to one of the Selling Partner API sandbox endpoints. You can determine which operations are sandbox-only by reviewing the Swagger model JSON for the API section. An operation that is sandbox-only contains "x-amzn-api-sandbox-only": true at either the operation or path level. When at the path level, all operations within the path are sandbox-only.

Las operaciones exclusivas del entorno aislado complementan la API de producción para que puedas crear procesos de prueba que no son posibles utilizando las operaciones de la API de producción. Por ejemplo, puedes tener un caso de uso en el que un elemento de datos se instancie a través de la interfaz de usuario, pero no a través de una API. Solo con fines de prueba, se puede proporcionar una API exclusiva del entorno aislado para crear el elemento de datos con el fin de permitir procesos de prueba más completos.

Endpoints del entorno aislado de la API del colaborador comercial

La API del colaborador comercial tiene endpoints del entorno aislado para las regiones de ventas de Norteamérica, Europa y Extremo Oriente.

Región de ventaEndpointRegión de AWS
Norteamérica (sitios web de Canadá, EE. UU., México y Brasil)https://sandbox.sellingpartnerapi-na.amazon.comus-east-1
Europa (sitios web de España, Reino Unido, Francia, Países Bajos, Alemania, Italia, Suecia, Polonia, Egipto, Turquía, Emiratos Árabes Unidos e India)https://sandbox.sellingpartnerapi-eu.amazon.comeu-west-1
Extremo Oriente (sitios web de Singapur, Australia y Japón)https://sandbox.sellingpartnerapi-fe.amazon.comus-west-2

¿Te ha ayudado esta página?