Selling Partner API for Tokens (2021-03-01)

Download OpenAPI specification:Download

The Selling Partner API for Tokens provides a secure way to access a customer's PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes subsequent calls to restricted operations that correspond to the restricted resources that you specified.

For more information, see the Tokens API Use Case Guide.

tokens

createRestrictedDataToken

Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII), plus a dataElements value that indicates the type of PII requested. See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 1 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Request Body schema: application/json

The restricted data token request details.

targetApplication
string

The application ID for the target application to which access is being delegated.

required
Array of objects (RestrictedResource)

A list of restricted resources. Maximum: 50

Responses

Request samples

Content type
application/json
{
  • "targetApplication": "string",
  • "restrictedResources": [
    ]
}

Response samples

Content type
application/json
{
  • "restrictedDataToken": "string",
  • "expiresIn": 0
}