# 概述
Selling Partner API for Tokens提供了一种安全的方式来访问客户的PII(Personally Identifiable Information).你可以调用Token API来获得一个或多个你指定的限制性资源的限制性数据令牌(RDT)，RDT授权后续调用与你指定的限制性资源对应的限制性操作.
更多信息，请参阅Tokens API用例指南 (opens new window).
# Version information
版本 : 2021-03-01
# Operations
createRestrictedDataToken
<a name="paths">
# 路径
<a name="createrestricteddatoken">
# createRestrictedDataToken
POST /tokens/2021-03-01/restrictedDataToken
# Description
为你指定的一个或多个受限资源返回一个受限数据令牌(RDT)，受限资源是来自返回个人身份信息的受限操作的HTTP方法和路径(PII)，加上一个表示请求的PII类型的dataElements值.，请参见Tokens API用例指南中的受限操作列表.，在后续调用相应的受限操作中使用这里返回的RDT作为接入令牌.
使用计划：
| 计划类型 | 速率(每秒的请求) | 突发 |
|---|---|---|
| Default | 1 | 10 |
| 销售伙伴具体 | 变量 | 变量 |
x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息，请参阅销售伙伴API文档中的 "使用计划和费率限制".
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | body required | The restricted data token request details. | CreateRestrictedDataTokenRequest |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. 头: x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) . x-amzn-RequestId (string) Unique request reference identifier. | CreateRestrictedDataTokenResponse |
错误状态代码、描述和模式，见错误响应和模式.
<a name="error-responses-and-schemas">
# 错误响应和模式
该表包含HTTP状态代码和错误响应的相关信息.
| HTTP Code | Description | Schema |
|---|---|---|
| 400 | Request有缺失或无效的参数，无法解析. Headers x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 401 | 请求的授权头格式不正确或不包含有效的令牌. 头 x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 403 | 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名. **头信息 x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 404 | 指定的资源不存在. 头 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作. x-amzn-RequestId (string):独特的请求参考标识符. | ErrorList |
| 415 | 请求的有效载荷是不支持的格式. 头信息 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 429 | 请求的频率超过了允许的范围. 标题 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已经过时，不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 500 | 发生了一个意外情况，使服务器无法完成请求. 头信息 x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作._注意 _对于这个状态代码，速率限制头已被废弃，不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
| 503 | 服务器的临时超载或维护. 头信息 x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作._注意 _对于这个状态代码，速率限制头已经过时，不再返回. x-amzn-RequestId (string):唯一的请求参考标识符. | ErrorList |
<a name="definitions">:唯一的请求参考标识符
# Definitions
<a name="createrestricteddatatokenrequest">
# CreateRestrictedDataTokenRequest
createRestrictedDataToken操作的请求模式.
| Name | Description | Schema |
|---|---|---|
| targetApplication optional | 被委托访问的目标应用程序的应用程序ID. | string |
| restrictedResources required | A list of restricted resources. Maximum: 50 | < RestrictedResource > 数组 |
<a name="restrictedresource">
# RestrictedResource
限制性资源的模型.
| Name | Description | Schema |
|---|---|---|
| method required | 限制资源中的HTTP方法. | enum (Method |
| path required | 受限资源中的路径.下面是一些路径的例子 - /orders/v0/orders.用于获取订单API的getOrders操作的RDT.用于批量订单.- /orders/v0/orders/123-1234567-1234567.用于获取RDT的 对于一个特定的订单.- /orders/v0/orders/123-1234567-1234567/orderItems. 用于获取订单API的getOrder操作的RDT. 用于获取订单API的getOrderItems操作的RDT.对于特定订单中的订单项目.- /mfn/v0/shipments/FBA1234ABC5D. 用于获取Shipping API的getShipment操作的RDT. 对于特定的shipment.- /mfn/v0/shipments/{shipmentId}. 用于为Shipping API的getShipment操作获取一个RDT. 对于您在调用getShipment操作时指定的销售伙伴的任何货件. | string |
| dataElements optional | 表示请求的个人身份信息的类型.这个参数只有在获取RDT用于订单API的getOrder、getOrders或getOrderItems操作时才需要.更多信息，请参阅Tokens API Use Case Guide (opens new window). 可能的值包括 - buyerInfo. 在订单层面，这包括关于买方的一般识别信息和税务相关信息. 在订单项目层面，这包括礼品包装信息和定制订单信息，如果有的话. - shippingAddress. 这包括履行订单的信息. - buyerTaxInformation. 这包括发行税务发票的信息. | < string> array |
<a name="createrestricteddatatokenresponse">
# CreateRestrictedDataTokenResponse
createRestrictedDataToken操作的响应模式.
| Name | Description | Schema |
|---|---|---|
| restrictedDataToken optional | A Restricted Data Token (RDT). 这是一个简短的-lived access token，授权调用受限制的操作. 在后续调用这些受限制的资源时，将此值与x-amz-access-token头一起传递给对方. | string |
| expiresIn optional | 受限数据令牌的寿命，以秒计. | integer |
<a name="error">
# Error
当请求不成功时返回的一个错误响应.
| Name | Description | Schema |
|---|---|---|
| code required | 一个错误代码，用于识别所发生的错误类型. | string |
| message required | 一个描述错误情况的信息. | string |
| details optional | 可以帮助呼叫者理解或解决这个问题的额外细节. | string |
<a name="errorlist">
# ErrorList
当一个请求不成功时返回的错误响应列表.
| Name | Schema |
|---|---|
| errors optional | < Error > array |
<a name="method">
# Method
限制资源中的HTTP方法.
类型 : 枚举
| Value | Description |
|---|---|
| GET | GET方法. |
| PUT | PUT方法. |
| POST | POST方法. |
| DELETE | DELETE方法. |