Referencia de la API de Tokens v2021-03-01

Descripción general

La Selling Partner API para tokens proporciona una forma segura de acceder a la PII (Personally Identifiable Information) de un cliente. Puede llamar a la API de tokens para obtener un Restricted Data Token (RDT) para uno o más recursos restringidos que especifique. La RDT autoriza llamadas posteriores a operaciones restringidas que corresponden a los recursos restringidos que especificó.

Para obtener más información, consulte la Guía de casos de uso de la API de tokens .

Información de versión

Versión : 2021-03-01

Información del contacto

Contacto : Soporte para desarrolladores Selling Partner API
URL de contacto : https://sellercentral.amazon.com/gp/mws/contactus.html

Información de licencia

Licencia : Licencia Apache 2.0
URL de la licencia : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Anfitrión : sellingpartnerapi-na.amazon.com
Schemas : HTTPS

Consume

application/json

Produce

application/json

Operaciones

createRestrictedDataToken

Rutas

POST /tokens/2021-03-01/restrictedDataToken

Operación: createRestrictedDataToken

Descripción

Devuelve un Restricted Data Token (RDT) para uno o más recursos restringidos que especifique. Un recurso restringido es el método HTTP y la ruta de una operación restringida que devuelve Personally Identifiable Information (PII), más un valor de elementos de datos que indica el tipo de PII solicitado. Consulte la Guía de casos de uso de la API de tokens para obtener una lista de operaciones restringidas. Utilice el RDT devuelto aquí como token de acceso en llamadas posteriores a las operaciones restringidas correspondientes.

Plan de uso:

Tasa (solicitudes por segundo)	Explosión
1	10

El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de velocidad del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica los valores de velocidad y ráfaga predeterminados para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de velocidad y ráfaga más altos que los mostrados aquí. Para obtener más información, consulta. Usage Plans and Rate Limits in the Selling Partner API.

Parámetros

Tipo	Nombre	Descripción	Schema
Body	body requerido	Los detalles de la solicitud del Restricted Data Token.	CreateRestrictedDataTokenRequest

Respuestas

HTTP Code	Descripción	Schema
200	Éxito. Headers : `x-amzn-RateLimit-Limit` (string): su límite de velocidad (solicitudes por segundo) para esta operación. `x-amzn-RequestId` (string): identificador de referencia de solicitud único.	CreateRestrictedDataTokenResponse

Para códigos de estado de error, descripciones y Schemas, consulte Respuestas y Schemas de error .

Respuestas de error y Schemas

Esta tabla contiene códigos de estado HTTP e información asociada para respuestas de error.

HTTP Code	Descripción	Schema
400	La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : `x-amzn-RateLimit-Limit` (string): su límite de velocidad (solicitudes por segundo) para esta operación. `x-amzn-RequestId` (string): identificador de referencia de solicitud único.	Lista de errores
401	El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. Headers : `x-amzn-RequestId` (string): identificador de referencia de solicitud único.	Lista de errores
403	Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : `x-amzn-RequestId` (string): identificador de referencia de solicitud único.	Lista de errores
404	El recurso especificado no existe. Headers : `x-amzn-RateLimit-Limit` (string): su límite de velocidad (solicitudes por segundo) para esta operación. `x-amzn-RequestId` (string): identificador de referencia de solicitud único.	Lista de errores
415	La carga útil de la solicitud está en un formato no admitido. Headers : `x-amzn-RateLimit-Limit` (string): su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. `x-amzn-RequestId` (string): identificador de referencia de solicitud único.	Lista de errores
429	La frecuencia de las solicitudes fue mayor a la permitida. Headers : `x-amzn-RateLimit-Limit` (string): su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. `x-amzn-RequestId` (string): identificador de referencia de solicitud único.	Lista de errores
500	Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers : `x-amzn-RateLimit-Limit` (string): su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. `x-amzn-RequestId` (string): identificador de referencia de solicitud único.	Lista de errores
503	Sobrecarga temporal o mantenimiento del servidor. Headers : `x-amzn-RateLimit-Limit` (string): su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. `x-amzn-RequestId` (string): identificador de referencia de solicitud único.	Lista de errores

Definiciones

CreateRestrictedDataTokenRequest

El Schema de solicitud para la operación createRestrictedDataToken.

Nombre	Descripción	Schema
targetApplication opcional	El ID de aplicación para la aplicación de destino a la que se delega el acceso.	string
restrictedResources requerido	Una lista de recursos restringidos. Máximo: 50	< RestrictedResource > array

RestrictedResource

Modelo de un RestrictedResource.

Nombre	Descripción	Schema
method requerido	El método HTTP en el recurso restringido.	enum ( method )
path requerido	La ruta en el recurso restringido. Aquí hay algunos ejemplos de rutas: - `/orders/v0/orders` . Para obtener un RDT para la operación getOrders de la Orders API. Para pedidos a granel. - `/orders/v0/orders/123-1234567-1234567` . Para obtener un RDT para la operación getOrder de la Orders API. Para un pedido específico. - `/orders/v0/orders/123-1234567-1234567/orderItems` . Para obtener un RDT para la operación getOrderItems de la Orders API. Para los artículos de pedido en un pedido específico. - `/mfn/v0/envíos/FBA1234ABC5D` . Para obtener un RDT para la operación getShipment de la Shipping API. Para un envío específico. - `/mfn/v0/shipments/{shipmentId}` . Para obtener un RDT para la operación getShipment de la Shipping API. Para cualquiera de los envíos de un selling partner's que especifique cuando llame a la operación getShipment.	string
dataElements opcional	Indica el tipo de información de identificación personal solicitada. Este parámetro solo es necesario cuando se obtiene una RDT para usar con la operación getOrder, getOrders o getOrderItems de la Orders API. Para obtener más información, consulte la Guía de casos de uso de la API de tokens . Los posibles valores incluyen: - buyerInfo . En el nivel de pedido, esto incluye información de identificación general sobre el comprador e información relacionada con los impuestos. En el nivel del artículo del pedido, esto incluye información sobre el envoltorio de regalo y la información del pedido personalizado, si está disponible. - shippingAddress . Esto incluye información para cumplir con los pedidos. - buyerTaxInformation . Esto incluye información para la emisión de facturas de impuestos.	< string > array

CreateRestrictedDataTokenResponse

El Schema de respuesta para la operación createRestrictedDataToken.

Nombre	Descripción	Schema
restrictedDataToken opcional	Un Restricted Data Token (RDT). Este es un token de acceso de corta duración que autoriza llamadas a operaciones restringidas. Pase este valor con el header x-amz-access-token cuando realice llamadas posteriores a estos recursos restringidos.	string
expiresIn opcional	La vida útil del Restricted Data Token, en segundos.	integer

Error

Se devolvió una respuesta de error cuando la solicitud no tuvo éxito.

Nombre	Descripción	Schema
código requerido	Un código de error que identifica el tipo de error que ocurrió.	string
mensaje requerido	Un mensaje que describe la condición de error.	string
detalles opcional	Detalles adicionales que pueden ayudar a la persona que llama a comprender o solucionar el problema.	string

Lista de errores

Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente.

Nombre	Schema
errores opcional	array

Método

El método HTTP en el recurso restringido.

Tipo : enum

Valor	Descripción
GET	El método GET.
PUT	El método PUT.
POST	El método POST.
DELETE	El método DELETE.