Uso de Postman para los modelos de la API del colaborador comercial

Uso de Postman para los modelos de la API del colaborador comercial

En este documento se explica cómo configurar y usar {{0}} para los modelos de la API del colaborador comercial (SP-API). Puedes utilizar {{1}} para generar tokens de acceso de Iniciar sesión con Amazon (LWA), importar modelos de la SP-API, realizar llamadas a endpoints de la SP-API y realizar llamadas a endpoints del entorno aislado de la SP-API.

Credenciales necesarias para realizar una llamada

Genere un token de acceso de inicio de sesión con Amazon (LWA) mediante Postman

Iniciar sesión con Amazon (LWA) permite a los clientes de Amazon iniciar sesión en sitios web o aplicaciones móviles externos registrados ("aplicaciones cliente") con su nombre de usuario y contraseña de Amazon. Las aplicaciones cliente pueden pedirles que compartan algunos datos personales de su perfil de Amazon, como el nombre, la dirección de correo electrónico y el código postal. Antes de poder usar {{0}} con los modelos de la SP-API, primero debes generar un token de acceso para autenticarte en la SP-API.

  1. Abrir Cartero e inicia sesión en tu cuenta.

  2. Para Workspaces, elige tu espacio de trabajo.

  3. Elige New.

  4. En el Create New cuadro de diálogo, elija HTTP Request.

    The Create New Window, which shows the HTTP Request as the first item to choose from.

  5. Para Request, elige POST.

    The Request dropdown menu with POST selected.

  6. Copia y pega el siguiente enlace en el cuadro de texto.

    https://api.amazon.com/auth/o2/token

    the link pasted into the request field.

  7. Elige el Authorization pestaña y para Type, elige No Auth.

    The Type dropdown menu with No Auth selected.

  8. Elige el Body pestaña y selecciona x-www-form-urlencoded.

    The Body tab selected and x-www-form-urlencoded selected.

  9. En el Body tabla, añada los siguientes pares clave-valor:

    ClaveValue
    grant_typerefresh_token
    refresh_token[el valor de tu token de actualización]
    client_id[el valor de tu identificador de cliente]
    client_secret[el valor de tu secreto de cliente]

    The key-value pairs from the table entered into the table on the Body tab.

  10. Elige Send.

La respuesta devuelve el token de acceso que se utiliza para autenticarse en la SP-API.

"access_token": "Atza|*****", "refresh_token": "Atzr|*****"' "token_type": "bearer", "expires_in": 3600

Importación de un modelo SP-API a Postman

Antes de llamar a un endpoint de SP-API, debes importar el modelo de la SP-API a {{0}}.

  1. Abre la carpeta selling-partner-api-models en GitHub.

  2. En la lista de carpetas, busca y selecciona el modelo de API que deseas descargar y, a continuación, elige el archivo JSON.

  3. En la vista de archivos JSON, elija Raw para ver el código fuente o selecciona el icono de descarga para descargar el archivo sin procesar.

  4. Copia el código fuente del modelo.

  5. Abre un editor de texto (como el Bloc de notas) y pega el texto del modelo. A continuación, guarda el archivo con la extensión ".json".

  6. Inicia sesión en Postman.

  7. Para Workspaces, elige tu espacio de trabajo.

  8. Elige Import, selecciona tu archivo JSON y, a continuación, elige Open.

  9. En el Import cuadro de diálogo, seleccione Postman Collection y elige Import.

    The Choose how to import your API pop-up page. The Postman Collection option is chosen and has a red box surrounding it. The Import button on the bottom right of the page is also surrounded by a red box.

Aparece un mensaje de éxito cuando el archivo se importa correctamente.

A success message stating that 1 out of 1 element was imported and the name of the collection Selling Partner API for Sellers.

Llamar a un endpoint de la SP-API

  1. Inicia sesión en Postman.

  2. Para Workspaces, elige tu espacio de trabajo.

  3. En el Collections pestaña, selecciona la API recién importada y elige GET operación.

  4. Si aún no lo has hecho, genera un token de acceso de LWA con Postman. Necesitarás un token de acceso de LWA para cambiarlo por un token de actualización.

  5. En el Headers pestaña, añada el siguiente par de claves:

    ClaveValue
    x-amz-access-token[el valor de tu token de acceso]

    The On the Headers tab, when the x-amz-access-token Key is highlighted and the Value is entered with sample text.

  6. Elige Send.

El texto de la respuesta se rellena en Response ventana.

Llamar a un endpoint del entorno aislado de la SP-API

El proceso para realizar llamadas a entornos aislados de la API del colaborador comercial es idéntico al de las llamadas de producción, excepto que las diriges a los endpoints de los entornos aislados de la API del colaborador comercial. La API del colaborador comercial ofrece dos entornos aislados que te permiten probar tus aplicaciones sin afectar a los datos de producción ni provocar eventos reales.

El entorno aislado estático de la API del colaborador comercial utiliza la coincidencia de patrones para devolver respuestas estáticas y simuladas. El entorno aislado dinámico de la API del colaborador comercial dirige las solicitudes a un backend de entorno aislado que puede devolver respuestas realistas en función de los parámetros de la solicitud.

Consulta Entorno aislado de la API del colaborador comercial para obtener más información.

  1. Inicia sesión en Postman.

  2. Importa el modelo Swagger de la API que estás utilizando a tu espacio de trabajo de https://github.com/amzn/selling-partner-api-models/blob/main/models/orders-api-model/ordersV0.json. Por ejemplo, el modelo Swagger de la API de pedidos.

  3. Para Workspaces, elige tu espacio de trabajo.

  4. En el Collections pestaña, elige tu colección y elige la GET operación. Por ejemplo, si quieres probar una llamada a la API GET Orders, selecciona get Orders Llamada a la API.

  5. Configura {{baseUrl}} como Selling Partner API sandbox (Entorno aislado de la API del colaborador comercial).

  6. En la pestaña Params (Parámetros), pasa los valores de solicitud estáticos del modelo Swagger. Por ejemplo, la API de pedidos.

    The Params tab, which has the CreatedAfter and Markdetplaceids Keys.

  7. Al llamar a un endpoint de entorno aislado, tendrás que comprobar que tu solicitud incluya todos los parámetros necesarios tal como se definen en el modelo Swagger correspondiente. Consulta el siguiente ejemplo de un modelo Swagger de la API de pedidos v0, donde la llamada a la API Get Order se resalta con una respuesta correcta:

    The Get Order API call, which has a successful response.

  8. Si aún no lo has hecho, genera un token de acceso de LWA con Postman. Necesitarás un token de acceso de LWA para cambiarlo por un token de actualización.

  9. En el Headers pestaña, añada el siguiente par de claves:

    ClaveValue
    x-amz-access-token[el valor de tu token de acceso]

    The On the Headers tab, when the x-amz-access-token Key is highlighted and the Value is entered with sample text.

  10. Elige Send.

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

    El texto de la respuesta se rellena en Response ventana.

    The Sandbox response example, which shows the returned order information.


¿Te ha ayudado esta página?