Tutorial: Probar los puntos finales de la API de los socios vendedores

Utilice el entorno de pruebas para realizar llamadas de prueba sin afectar a los datos de producción.

Selling Partner API (SP-API) provides sandbox environments where you can test the SP-API endpoints without affecting production data. You can direct calls to the SP-API sandbox endpoints to make static requests that return mock responses. By using the sandbox, you can practice the steps required to make a call, gain an understanding of the request and response formats, practice validating application credentials, and play with API endpoints without impacting production data.

Tutorial

El siguiente tutorial muestra cómo generar los tokens de acceso necesarios y realizar llamadas a los puntos finales del entorno limitado de SP-API.

Requisitos

Para completar este tutorial, necesita los siguientes requisitos previos:

  • A Postman account and workspace. For more information on how to use Postman, refer to Using Postman for Selling Partner API models.
  • If you have your own selling partner account, you can self authorize your application to access your account information.
  • If you don’t have your own selling partner account, then you must set up a third-party OAuth workflow. With this workflow, third-party sellers and vendors can authorize your application to access their Amazon Selling Partner data.

Durante este proceso, recibirá un token de actualización que podrá cambiar más adelante por un token de acceso. Se necesita un token de acceso para llamar a los puntos finales de SP-API.

Variables necesarias para realizar pruebas con Postman

Para realizar llamadas con Postman, primero debes configurar las credenciales. Necesitarás las siguientes variables globales para tu espacio de trabajo:

Flujo de trabajo gradual

Puedes seguir los pasos siguientes para probar un punto final de la API de un socio vendedor:

Paso 1. Genere un inicio de sesión con el token de acceso de Amazon (LWA)

En primer lugar, debes autorizar tu aplicación para acceder a los datos de venta en nombre de un socio vendedor. Cuando generas un token de acceso para iniciar sesión con Amazon (LWA), puedes usarlo para varias llamadas a la SP-API hasta que caduque.

For detailed steps, refer to Generate an LWA Access Token using Postman or Step 1. Request a Login with Amazon access token.

The response returns an LWA access token that you can use to authenticate your SP-API call. An LWA access token must be included in calls to all operations (except restricted operations) that return Personally Identifiable Information (PII). When calling restricted operations, you include a Restricted Access Token (RDT) instead of an LWA access token

La siguiente imagen muestra un ejemplo en el que se inicia el token de acceso Atza|**************************** y caduca en 3600 segundos (1 hora) (el número de segundos que transcurren antes de que el token de acceso de LWA deje de ser válido).

2034

Solicitud y respuesta del token de acceso LWA

Paso 2. Realice una llamada al punto final del entorno limitado de SP-API

Los siguientes pasos explican cómo practicar la realización de una llamada al punto final del entorno limitado de SP-API mediante el modelo Swagger de la API de pedidos. Puedes usar este proceso para probar las llamadas a la API y examinar las solicitudes y respuestas simuladas.

  1. Import the Orders API Swagger model to your Postman workspace.
  2. Busca en el código un x-amzn-api-sandbox objeto que contiene una matriz estática de ejemplos de solicitudes y respuestas para llamadas estáticas de entorno limitado a la operación de la API en la que aparecen.
  3. Configura los parámetros de la solicitud con los mismos valores que define el modelo Swagger de la API de pedidos.
  4. Compruebe que su solicitud incluye todos los parámetros necesarios tal y como se definen en el modelo Swagger correspondiente. El siguiente ejemplo muestra un API de pedidos v0 Modelo Swagger, donde Get Order La llamada a la API se destaca con una respuesta exitosa:
2148

API de pedidos v0, modelo Swagger

  1. Haz un GET Llama a /orders/v0/orders.
  2. Set the baseUrl as Selling Partner API sandbox.
  3. Bajo el Parámetros pestaña, pasa los valores de solicitud estáticos del modelo de API de pedidos.
2704

Valores de solicitud estáticos en la pestaña Parámetros

  1. Under the Headers tab, pass the access_token received in Step 1 for each API call, using the key value pair x-amz-access-token: Atc|********************. Skip this step for restricted operations and grantless operations.
2720

Token de acceso en la pestaña Encabezados

  1. For restricted operations, pass the Restricted Data Token (RDT) received from the createRestrictedDataToken operations using the key value pair x-amz-access-token: Atz.sprdt|********************.

🚧

Importante

If you are calling a restricted operation to access a customer's Personally Identifiable Information (PII), such as buyer information or a shipping address, pass a Restricted Data Token (RDT) in the request headers instead of an LWA access token. You can call the createRestrictedDataToken operation in Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify.

El siguiente ejemplo de respuesta devuelve un RDT y su fecha de caducidad. El token de RDT se puede usar en Get Orders operación para recuperar datos de PII.

2708

Tiempo de respuesta y caducidad del token de datos restringido

{ "restrictedDataToken": "Atz.sprdt|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR", "expiresIn": 3600 }

  1. Comprueba que la respuesta devuelva una carga útil que coincida con el modelo Swagger.
2698

Respuesta estática de la API Get Orders v0 mediante un token de acceso

Usa el entorno limitado dinámico de la API de socios vendedores para realizar solicitudes con estado

The SP-API also provides a dynamic sandbox where you can make requests and receive varied responses that are potentially stateful and that react to input.

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 se puede encontrar en el nivel de operación o de ruta. Cuando se encuentran en el nivel de ruta, todas las operaciones dentro de la ruta pueden realizar llamadas al entorno limitado dinámico.

For more details on how to make calls to the dynamic sandbox, refer to How to make a dynamic sandbox call to the Selling Partner API.

Conclusión

En este tutorial, aprendió a probar los puntos finales de su caja de pruebas de SP-API. En el tutorial, generaste un token de acceso de LWA y exploraste ejemplos de llamadas de SP-API a los puntos finales del sandbox.


¿Te ha ayudado esta página?