Guia de casos de uso da API de tokens

Use o token de dados restrito para ter acesso seguro às APIs do parceiro de vendas.

Versão da API: 2021-03-01

O que é a API de tokens?

The Selling Partner API for Tokens (Tokens API) provides a secure way to access a customer's Personally Identifiable Information (PII). You can call the createRestrictedDataToken operation of the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. Or, if you have a delegatee application, you can get an RDT from a delegator application owned by a developer that you work closely with (refer to Delegating authorization). In either case, an RDT authorizes you to make calls to operations that return restricted data. For definitions, refer to Terminology.

When you call a restricted operation, you include an RDT in the x-amz-access-token header. This is in contrast to other Selling Partner API operations, where you include an LWA access token in the x-amz-access-token header. For more information, refer to Step 3. Add headers to the URI.

Como delegar autorizações

With the Tokens API, a delegator application can get an RDT that delegates authorization to access PII to a delegatee application. The delegator application is authorized by the selling partner and is the application that the selling partner interacts with. The delegatee application performs a specialized function that requires PII, such as shipping, tax invoicing, or tax remittance services. These two applications are owned by different developers and are closely integrated, such that the delegator application can securely transmit an RDT to the delegatee application. For more information about delegating authorization using an RDT, refer to Tutorial: Delegate authorization to access PII.

Terminologia

  • Token de dados restritos (RDT): um token de acesso de curta duração que autoriza operações restritas de chamadas. Um RDT permanece válido por uma hora.

  • Restricted operation. An operation that returns restricted data, such as PII. You need an RDT to call a restricted operation.

  • Recurso restrito: um método e um caminho HTTP que representam uma operação restrita.

  • Restricted report type. A report type that contains PII. Refer to Restricted report types.

  • Aplicativo delegador: um aplicativo que obtém um RDT e o passa para um aplicativo delegado. O parceiro de vendas autoriza e interage com o aplicativo delegador.

  • Aplicativo delegado: um aplicativo que obtém autorização para chamar operações restritas de um RDT que é passado para ele por um aplicativo delegador. Um aplicativo delegado executa uma função especializada que requer PII, como frete, faturamento fiscal ou serviços de remessa de impostos, e não é diretamente autorizado pelo parceiro de vendas.

  • Specific path. A path in a restricted resource that contains a specific order or shipment identifier. For example, orders/v0/orders/902-3159896-1390916/address.

  • Generic path. A path in a restricted resource that contains a generic identifier, such as {orderId} or {shipmentId}. For example, orders/v0/orders/{orderId}/address.

Operações restritas

As operações restritas retornam as Informações pessoais identificáveis (PII) dos clientes. Você precisa de um RDT para chamar uma operação restrita.

Aqui está uma lista de operações restritas, agrupadas por API:

API de pedidos de atendimento direto:

  • getOrders
  • getOrder

API de pedidos de atendimento direto v2021-12-28

  • getOrders
  • getOrder

API de envio de atendimento direto

  • getShippingLabel
  • getShippingLabels
  • getPackingSlip
  • getPackingSlips
  • getCustomerInvoice
  • getCustomerInvoices
  • createShippingLabels

API de envio de atendimento direto v2021-12-28

  • getShippingLabel
  • getCustomerInvoices
  • getCustomerInvoice
  • getPackingSlips
  • getPackingSlip

API do Easy Ship v2022-03-23

  • createScheduledPackageBulk

API de envio do comerciante:

  • getShipment
  • cancelShipment
  • cancelShipmentOld
  • createShipment

API de pedidos:

  • getOrders
  • getOrder
  • getOrderItems
  • getOrderRegulatedInfo
  • getOrderAddress
  • getOrderBuyerInfo
  • getOrderItemsBuyerInfo

API de relatórios:

  • getReportDocument

Observações

  • The getReportDocument operation is considered a restricted operation only when a restricted report type is specified. Refer to the list of restricted report types.
  • When calling the createRestrictedDataToken operation to get an RDT for the getReportDocument operation, the specified restricted resource can contain only a specific path, not a generic path. For definitions, refer to Terminology.
  • When using RDT to access the getReportDocument operation, make sure your application has the correct right roles to access the report. Refer to Roles in the Selling Partner API for roles to reports mapping.

Faturamento do envio:

  • getShipmentDetails

API de envio:

  • getShipment

Tipos de relatórios restritos

Os tipos de relatórios restritos contêm PII. Ao especificar um tipo de relatório restrito em uma chamada para a operação getReportDocument, você deve passar um RDT com a chamada.

Aqui está uma lista de tipos de relatórios restritos:

  • GET_AMAZON_FULFILLED_SHIPMENTS_DATA_INVOICING
  • GET_AMAZON_FULFILLED_SHIPMENTS_DATA_TAX
  • GET_FLAT_FILE_ACTIONABLE_ORDER_DATA_SHIPPING
  • GET_FLAT_FILE_ORDER_REPORT_DATA_SHIPPING
  • GET_FLAT_FILE_ORDER_REPORT_DATA_INVOICING
  • GET_FLAT_FILE_ORDER_REPORT_DATA_TAX
  • GET_FLAT_FILE_ORDERS_RECONCILIATION_DATA_TAX
  • GET_FLAT_FILE_ORDERS_RECONCILIATION_DATA_INVOICING
  • GET_FLAT_FILE_ORDERS_RECONCILIATION_DATA_SHIPPING
  • GET_ORDER_REPORT_DATA_INVOICING
  • GET_ORDER_REPORT_DATA_TAX
  • GET_ORDER_REPORT_DATA_SHIPPING
  • GET_EASYSHIP_DOCUMENTS
  • GET_GST_MTR_B2B_CUSTOM
  • GET_VAT_TRANSACTION_DATA
  • SC_VAT_TAX_REPORT

Tutorial: Obtenha autorização para acessar tipos de relatórios restritos com informações de PII

  • The getReportDocument operation is considered a restricted operation only when a restricted report type is specified. Refer to the list of restricted report types.

  • When calling the createRestrictedDataToken operation to get an RDT for the getReportDocument operation, the specified restricted resource can contain only a specific path, not a generic path. For definitions, refer to Terminology.

Pré-requisitos

Para concluir este tutorial, você precisará do seguinte:

  • Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.

  • Aprovação para as seguintes funções:

    • Envio direto ao consumidor: necessário para acessar as informações do endereço de entrega.
    • Remessa de impostos: necessário para acessar as informações do comprador.
    • Faturamento fiscal: necessário para acessar as informações do comprador.

    To request access to these roles, refer to Registering as a developer and update your developer profile.

Etapa 1: obter um RDT

  1. Call the createRestrictedDataToken operation, passing the following parameters:

Parâmetro do corpo:

ParâmetroDescriçãoObrigatório
restrictedResourcesA list of restricted resources. Note: Growth in the number of restricted resources results in growth in the size of the resulting restricted data token. The maximum size of the restricted data token before encoding and encryption cannot exceed 7kb without risk of failure when the token is employed. When requesting multiple resources, make sure that the resources requested are valid for the selling partner account type. For example, if requesting an RDT token for a seller, do not include vendor specific APIs in the createRestrictedDataToken request call. Type: < RestrictedResource > array

Exemplo de solicitação

POST https://sellingpartnerapi-na.amazon.com/tokens/2021-03-01/restrictedDataToken { "restrictedResources": [ { "method": "GET", "path": "/reports/2021-06-30/documents/amzn1.spdoc.1.4.eu.dca0cb77-4733-4769-8476-f09bc32be2af.T1KIM200NIMFNU.1234" } ] }

Resposta

Uma resposta bem-sucedida inclui o seguinte:

NomeDescrição
restrictedDataTokenUm token de dados restrito (RDT). Esse é um token de acesso de curta duração que autoriza chamadas para operações restritas. Passe esse valor com o x-amz-access-token cabeçalho ao fazer chamadas subsequentes para esses recursos restritos. O tamanho do RDT é relativo ao número de recursos restritos especificados na solicitação. O tamanho máximo do token de dados restrito antes da codificação e criptografia não pode exceder 7 kb sem risco de falha quando o token é empregado. Tipo: string
expiresInA vida útil do Token de Dados Restritos, em segundos. Tipo: inteiro

Exemplo de resposta

{ "restrictedDataToken": "Atz.sprdt|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR", "expiresIn": 3600 }
  1. Salve o restrictedDataToken valor (o RDT) para fornecê-lo no getReportDocument operação.

Tutorial: obtenha autorização para acessar as PII para pedidos em massa

You can get an RDT that provides authorization to access Personally Identifiable Information (PII) for bulk orders. The dataElements values that you specify (using the restrictedResources parameter of the createRestrictedDataToken operation) determine the type of restricted data that the RDT authorizes your application to access. In this tutorial we request an RDT that authorizes access to both buyer information and shipping address information.

Pré-requisitos

Para concluir este tutorial, você precisará do seguinte:

  • Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.

  • Aprovação para as seguintes funções:

    • Envio direto ao consumidor: necessário para acessar as informações do endereço de entrega.
    • Remessa de impostos: necessário para acessar as informações do comprador.
    • Faturamento fiscal: necessário para acessar as informações do comprador.

    To request access to these roles, refer to Registering as a developer and update your developer profile.

Etapa 1: obter um RDT

Chame a operação createRestrictedDataToken para obter um RDT.

  1. Call the createRestrictedDataToken operation, passing the following parameters:

Parâmetro do corpo:

Parâmetro Descrição Obrigatório
restrictedResources

Uma lista de recursos restritos. Observação:

  1. O crescimento no número de recursos restritos resulta no crescimento do tamanho do token de dados restrito resultante. O tamanho máximo do token de dados restrito antes da codificação e criptografia não pode exceder 7 kb sem risco de falha quando o token é empregado.
  2. Ao solicitar vários recursos, certifique-se de que os recursos solicitados sejam válidos para o tipo de conta do parceiro de vendas. Por exemplo, se solicitar um token RDT para um vendedor, não inclua APIs específicas do fornecedor na createRestrictedDataToken solicitar chamada.

Type: < RestrictedResource > array

Sim

Exemplo de solicitação

POST https://sellingpartnerapi-na.amazon.com/tokens/2021-03-01/restrictedDataToken { "restrictedResources": [ { "method": "GET", "path": "/orders/v0/orders", "dataElements": ["buyerInfo", "shippingAddress"] } ] }

Resposta

Uma resposta bem-sucedida inclui o seguinte:

Nome Descrição
restrictedDataToken

Um token de dados restrito (RDT). Esse é um token de acesso de curta duração que autoriza chamadas para operações restritas. Passe esse valor com o cabeçalho de x-amz-access-token ao fazer chamadas subsequentes para esses recursos restritos.

O tamanho do RDT é relativo ao número de recursos restritos especificados na solicitação. O tamanho máximo do token de dados restrito antes da codificação e criptografia não pode exceder 7 kb sem risco de falha quando o token é empregado.

Tipo: string

expiresIn

A vida útil do RDT, em segundos.

Tipo: inteiro

Exemplo de resposta

{ "restrictedDataToken": "Atz.sprdt|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR", "expiresIn": 3600 }
  1. Save the restrictedDataToken value (the RDT) to use in Step 2. Include the RDT with a call to the getOrders operation

Etapa 2: incluir o RDT com uma chamada para a operação getOrders

Call the getOrders operation of the Orders API, specifying the appropriate parameters to filter for the orders that you want. Be sure to include the RDT from Step 1. Get an RDT in the x-amz-access-token header of your call to getOrders. Because you specified both buyerInfo and shippingAddress in Step 1. Get an RDT, your call to getOrders is authorized to return both buyer information and shipping address information for each order. Had you specified only buyerInfo in Step 1, getOrders would be authorized to return only buyer information for each order. Had you specified only shippingAddress in Step 1, getOrders would be authorized to return only shipping address information for each order.

Tutorial: obtenha autorização para acessar as PII dos itens do pedido em um pedido

Você pode obter um RDT que forneça autorização para acessar Informações de identificação pessoal (PII) nos itens do pedido em um pedido especificado. Neste fluxo de trabalho, você especifica dataElements=buyerInfo para indicar que o RDT autorizará seu aplicativo a acessar as informações do comprador para os itens do pedido.

Pré-requisitos

Para concluir este tutorial, você precisará do seguinte:

  • Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.

  • Aprovação para as seguintes funções:

    • Remessa de impostos
    • Faturamento fiscal

    Depending on your use case, you might need approval for only one of these roles. To learn more about roles and request access, refer to Registering as a developer and update your developer profile.

Etapa 1: obter um ID de pedido

Você precisa de um ID do pedido para identificar um pedido para o qual deseja informações sobre o item do pedido. Você também precisa de um ID do pedido para obter um RDT que autorize seu aplicativo a acessar as informações do comprador para os itens do pedido. Você pode usar a operação getOrders da API de pedidos para obter uma lista de pedidos, a partir da qual você pode obter um ID do pedido no qual está interessado.

  1. Call the getOrders operation of the Orders API, specifying the appropriate parameters to filter for the order that you want.

    A operação retorna pedidos que correspondem à sua solicitação. Cada pedido inclui um ID do pedido.

  2. Nos pedidos devolvidos, identifique o pedido para o qual você deseja obter informações sobre o item do pedido.

  3. Save the order ID for the order that you want, to use in Step 2. Get an RDT and Step 3. Include the RDT with a call to the getOrderItems operation.

Etapa 2: obter um RDT

Call the createRestrictedDataToken operation to get an RDT. In the path property of the restrictedResources parameter, include the order ID from Step 1. Get an order ID. In this workflow we will specify the buyerInfo value of the dataElements parameter. This indicates that the RDT should provide authorization to access PII for use cases such as tax and gift wrapping.

Chame a operação createRestrictedDataToken para obter um RDT.

  1. Call the createRestrictedDataToken operation, passing the following parameter:

Parâmetro do corpo:

Parâmetro Descrição Obrigatório
restrictedResources

Uma lista de recursos restritos. Observação:

  1. O crescimento no número de recursos restritos resulta no crescimento do tamanho do token de dados restrito resultante. O tamanho máximo do token de dados restrito antes da codificação e criptografia não pode exceder 7 kb sem risco de falha quando o token é empregado.
  2. Ao solicitar vários recursos, verifique se os recursos solicitados são válidos para o tipo de conta do parceiro de vendas. Exemplo: se estiver solicitando um token RDT para um vendedor, não inclua APIs específicas do fornecedor na chamada de solicitação de createRestrictedDataToken.

Type: < RestrictedResource > array

Sim

Exemplo de solicitação

POST https://sellingpartnerapi-na.amazon.com/tokens/2021-03-01/restrictedDataToken { "restrictedResources": [ { "method": "GET", "path": "/orders/v0/orders/123-1234567-1234567/orderItems", "dataElements": ["buyerInfo"] } ] }

Resposta

Uma resposta bem-sucedida inclui o seguinte:

Nome Descrição
restrictedDataToken

Um token de dados restrito (RDT). Esse é um token de acesso de curta duração que autoriza chamadas para operações restritas. Passe esse valor com o cabeçalho de x-amz-access-token ao fazer chamadas subsequentes para esses recursos restritos.

O tamanho do RDT é relativo ao número de recursos restritos especificados na solicitação. O tamanho máximo do token de dados restrito antes da codificação e criptografia não pode exceder 7 kb sem risco de falha quando o token é empregado.

Tipo: string

expiresIn

A vida útil do RDT, em segundos.

Tipo: inteiro

Exemplo de resposta

{ "restrictedDataToken": "Atz.sprdt|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR", "expiresIn": 3600 }
  1. Save the restrictedDataToken value (the RDT) to use in Step 3. Include the RDT with a call the getOrder operation.

Etapa 3: incluir o RDT com uma chamada para a operação getOrderItems

Call the getOrderItems operation of the Orders API, specifying the order ID that you identified in Step 1. Get an order ID. Be sure to include the RDT from Step 1 in the x-amz-access-token header of your call to getOrderItems.

Tutorial: delegar autorização para acessar as PII

Você pode delegar autorização para chamar operações restritas a um “aplicativo delegado”, que é um aplicativo que executa uma função especializada para um parceiro de vendas (como frete, faturamento fiscal ou serviços de remessa de impostos), mas não é autorizado diretamente pelo parceiro de vendas. Você delega autorização dessa forma por

  1. Calling the createRestrictedDataToken operation of the Tokens API (specifying the application ID of the delegatee application),
  2. Obtendo um RDT da resposta de createRestrictedDataToken e
  3. Passando o RDT para o aplicativo delegado.

The RDT authorizes the delegatee application to call restricted operations that return the PII required to perform functions on behalf of the selling partner. For definitions, refer to Terminology.

Pré-requisitos

Para concluir este tutorial, você precisará do seguinte:

  • Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.

  • To have indicated in the App registration form that you want to delegate access to PII to another application. For instructions for updating the App registration form, refer to Registering your application. Indicate in the form the types of PII that you want to delegate.

  • O ID do pedido que exige a funcionalidade de frete ou imposto.

  • Uma parceria com um desenvolvedor com um aplicativo delegado.

  • O ID do aplicativo delegado.

  • Um meio seguro de transmitir um RDT e um ID de pedido para um aplicativo delegado.

In addition, the developer with the delegatee application in Step 3. The delegatee application calls the getOrder operation will need to:

  • Register as a developer, requesting approval for the roles that are required to access buyer information and shipping address information. These are:

    • Envio direto ao consumidor: necessário para acessar as informações do endereço de entrega.
    • Remessa de impostos: necessário para acessar as informações do comprador.
    • Faturamento fiscal: necessário para acessar as informações do comprador.

    For more information about roles, refer to Roles in the Selling Partner API.

Etapa 1: obter um RDT

Chame a operação createRestrictedDataToken para obter um RDT. Na propriedade path do parâmetro restrictedResources, inclua o ID do pedido para o qual a PII é necessária. Nesse fluxo de trabalho, especificaremos os valores buyerInfo e shippingAddress do parâmetro dataElements. Isso indica que o RDT deve incluir autorização para acessar a PII para casos de uso como impostos e frete. Em seu próprio fluxo de trabalho, você pode especificar somente um valor, dependendo da PII que seu caso de uso exige.

  1. Call the createRestrictedDataToken operation, passing the following parameters:

Parâmetros corporais:

Parâmetro Descrição Obrigatório
restrictedResources

Uma lista de recursos restritos. Observação:

  1. O crescimento no número de recursos restritos resulta no crescimento do tamanho do token de dados restrito resultante. O tamanho máximo do token de dados restrito antes da codificação e criptografia não pode exceder 7 kb sem risco de falha quando o token é empregado.
  2. Ao solicitar vários recursos, verifique se os recursos solicitados são válidos para o tipo de conta do parceiro de vendas. Exemplo: se estiver solicitando um token RDT para um vendedor, não inclua APIs específicas do fornecedor na chamada de solicitação de createRestrictedDataToken.

Type: < RestrictedResource > array

Sim
targetApplication

O ID do aplicativo de destino ao qual o acesso está sendo delegado.

Tipo: string

Não

Exemplo de solicitação

POST https://sellingpartnerapi-na.amazon.com/tokens/2021-03-01/restrictedDataToken { "restrictedResources": [ { "method": "GET", "path": "/orders/v0/orders/123-1234567-1234567", "dataElements": ["buyerInfo", "shippingAddress"] } ], "targetApplication": "amzn1.sellerapps.app.target-application" }

Resposta

Uma resposta bem-sucedida inclui o seguinte:

Nome Descrição
restrictedDataToken

Um token de dados restrito (RDT). Esse é um token de acesso de curta duração que autoriza chamadas para operações restritas. Passe esse valor com o cabeçalho de x-amz-access-token ao fazer chamadas subsequentes para esses recursos restritos.

O tamanho do RDT é relativo ao número de recursos restritos especificados na solicitação. O tamanho máximo do token de dados restrito antes da codificação e criptografia não pode exceder 7 kb sem risco de falha quando o token é empregado.

Tipo: string

expiresIn

A vida útil do RDT, em segundos.

Tipo: inteiro

Exemplo de resposta

{ "restrictedDataToken": "Atz.sprdt|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR", "expiresIn": 3600 }
  1. Salve o valor restrictedDataToken (o RDT) a ser fornecido ao aplicativo delegado na etapa seguinte.

Etapa 2: passar o RDT e o ID do pedido para o aplicativo delegado

Transmita com segurança o RDT e o ID do pedido para o aplicativo delegado. O aplicativo os usará ao chamar a operação getOrder na etapa seguinte.

Etapa 3: o aplicativo delegado chama a operação getOrder

The delegatee application calls the getOrder operation of the Orders API, specifying in the path the order ID from Step 2. Pass the RDT and order ID to the delegatee application. The call must include the RDT (also from Step 2) in the x-amz-access-token header of the call. Because both buyerInfo and shippingAddress were specified in Step 1. Get an RDT, the call to getOrder returns both buyer information and shipping address information for the order.

  1. The delegatee application calls the getOrder operation, passing the following parameters:

Parâmetros corporais:

Parâmetro Descrição Obrigatório
orderId

Um identificador de pedido definido pela Amazon, no formato 3-7-7.

Tipo: string

Sim

Exemplo de solicitação

GET https://sellingpartnerapi-na.amazon.com/orders/v0/orders/123-1234567-1234567

Resposta

Uma resposta bem-sucedida inclui o seguinte:

Nome Descrição
payload

A carga útil para a operação getOrder.

Type: Order

Exemplo de resposta

{ "payload": { "AmazonOrderId": "902-3159896-1390916", "PurchaseDate": "2017-01-20T19:49:35Z", "LastUpdateDate": "2017-01-20T19:49:35Z", "OrderStatus": "Pending", "FulfillmentChannel": "SellerFulfilled", "NumberOfItemsShipped": 0, "NumberOfItemsUnshipped": 0, "PaymentMethod": "Other", "PaymentMethodDetails": [ "CreditCard", "GiftCerificate" ], "MarketplaceId": "ATVPDKIKX0DER", "ShipmentServiceLevelCategory": "Standard", "OrderType": "StandardOrder", "EarliestShipDate": "2017-01-20T19:51:16Z", "LatestShipDate": "2017-01-25T19:49:35Z", "IsBusinessOrder": false, "IsPrime": false, "IsGlobalExpressEnabled": false, "IsPremiumOrder": false, "IsSoldByAB": false, "DefaultShipFromLocationAddress": { "Name": "MFNIntegrationTestMerchant", "AddressLine1": "2201 WESTLAKE AVE", "City": "SEATTLE", "StateOrRegion": "WA", "PostalCode": "98121-2778", "CountryCode": "US", "Phone": "+1 480-386-0930 ext. 73824", "AddressType": "Commercial" }, "FulfillmentInstruction": { "FulfillmentSupplySourceId": "sampleSupplySourceId" }, "IsISPU": false, "ShippingAddress": { "Name": "Michigan address", "AddressLine1": "1 Cross St.", "City": "Canton", "StateOrRegion": "MI", "PostalCode": "48817", "CountryCode": "US" }, "BuyerInfo": { "BuyerEmail": "user@example.com", "BuyerName": "John Doe", "BuyerTaxInfo": { "CompanyLegalName": "A Company Name" }, "PurchaseOrderNumber": "1234567890123" } } }
  1. O aplicativo delegado usa os dados na resposta para realizar suas funções de envio e cálculo de impostos.

Tutorial: obter autorização para acessar as informações de envio para vários envios

Você pode obter um RDT que fornece autorização para conseguir informações de envio para qualquer remessa de um parceiro de vendas.

Pré-requisitos

Para concluir este tutorial, você precisará do seguinte:

  • Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API applications for more information.

  • Approval for the Direct-to-consumer shipping role, which is required to access shipping address information. To request access to this role, refer to Registering as a developer and update your developer profile.

  • IDs de envio para envios sobre os quais você deseja obter informações.

Etapa 1: obter um RDT

Call the createRestrictedDataToken operation to get an RDT. In the path property of the restrictedResources parameter that you specify, use a generic path that includes this text: {shipmentId}. For definitions, refer to Terminology.

  1. Call the createRestrictedDataToken operation, passing the following parameter:

Parâmetros corporais:

Parâmetro Descrição Obrigatório
restrictedResources

Uma lista de recursos restritos. Observação:

  1. O crescimento no número de recursos restritos resulta no crescimento do tamanho do token de dados restrito resultante. O tamanho máximo do token de dados restrito antes da codificação e criptografia não pode exceder 7 kb sem risco de falha quando o token é empregado.
  2. Ao solicitar vários recursos, verifique se os recursos solicitados são válidos para o tipo de conta do parceiro de vendas. Exemplo: se estiver solicitando um token RDT para um vendedor, não inclua APIs específicas do fornecedor na chamada de solicitação de createRestrictedDataToken.

Type: < RestrictedResource > array

Sim

Exemplo de solicitação

POST https://sellingpartnerapi-na.amazon.com/tokens/2021-03-01/restrictedDataToken { "restrictedResources": [ { "method": "GET", "path": "/mfn/v0/shipments/{shipmentId}" } ] }

Resposta

Uma resposta bem-sucedida inclui o seguinte:

Nome Descrição
restrictedDataToken

Um token de dados restrito (RDT). Esse é um token de acesso de curta duração que autoriza chamadas para operações restritas. Passe esse valor com o cabeçalho de x-amz-access-token ao fazer chamadas subsequentes para esses recursos restritos.

O tamanho do RDT é relativo ao número de recursos restritos especificados na solicitação. O tamanho máximo do token de dados restrito antes da codificação e criptografia não pode exceder 7 kb sem risco de falha quando o token é empregado.

Tipo: string

expiresIn

A vida útil do RDT, em segundos.

Tipo: inteiro

Exemplo de resposta

{ "restrictedDataToken": "Atz.sprdt|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR", "expiresIn": 3600 }
  1. Save the restrictedDataToken value (the RDT) to use in Step 2. Include the RDT with a call the getShipment operation.

    For definitions, refer to Terminology.

Etapa 2: incluir o RDT com uma chamada da operação getShipment

Call the getShipment operation of the Merchant Fulfillment API, using the generic path that you specified in Step 1. Get an RDT and replacing {shipmentId} with a real shipment ID from the selling partner. For example, GET /mfn/v0/shipments/FBA1234ABC5D. Repeat this step for all of the shipments for which you want shipping information, specifying the appropriate shipment ID with each call. Each call must include the RDT from Step 1. Get an RDT in the x-amz-access-token header.

📘

Observação

An RDT remains valid for one hour.

Tutorial: gerar um SDK para a API Tokens

Você pode encontrar as etapas que descrevem como gerar um SDK para a API Tokens em Java ou C# a seguir:

If you're using the Java SDK, you should also:

  1. Corra mvn package dentro da pasta SDK gerada.

  2. Download any of the following files and use them to build classes inside the main/java/sampleCode/ folder of the generated client library. For definitions, refer to Terminology.

🚧

Use a versão mais recente da API Tokens

Use the latest version of tokens_2021-03-01.json when generating your SDK to ensure that you are getting the latest functionality.


Esta página ajudou você?