Especificações da API

O Selling Partner API for Tokens fornece uma maneira segura de acessar as PII (informações de identificação pessoal) de um cliente. Você pode chamar a API de tokens para obter um token de dados restrito (RDT) para um ou mais recursos restritos que você especificar. O RDT autoriza chamadas subsequentes para operações restritas que correspondem aos recursos restritos que você especificou.

Casos de uso

O Selling Partner API for Tokens (Tokens API) fornece uma maneira segura de acessar as informações de identificação pessoal (PII) de um cliente.

A Selling Partner API for Tokens fornece uma maneira segura de acessar as PII (informações de identificação pessoal) de um cliente. Você pode chamar a API de tokens para obter um token de dados restrito (RDT) para um ou mais recursos restritos que você especificar. O RDT autoriza você a fazer solicitações subsequentes para acessar esses recursos restritos.

Definições

CreateRestrictedDataToken

O esquema de resposta para a operação getOrders.

Retorna um Restricted Data Token (RDT) para um ou mais recursos restritos que você especificar. Um recurso restrito é o método HTTP e o caminho de uma operação restrita que retorna informações de identificação pessoal (PII). Consulte o Guia de caso de uso da API de tokens para obter uma lista de operações restritas. Use o RDT retornado aqui como o token de acesso em chamadas subsequentes para as operações restritas correspondentes.

O caminho de um recurso restrito pode ser:

  • Um caminho específico contendo um ID de pedido do vendedor, por exemplo /orders/v0/orders/902-3159896-1390916/address. O RDT retornado autoriza uma chamada subsequente para a operação getOrderAddress da API de pedidos somente para aquele pedido específico. Por exemplo, GET /orders/v0/orders/902-3159896-1390916/address.

  • Um caminho genérico que não contém um ID de pedido do vendedor, por exemplo /orders/v0/orders/{orderId}/address. O RDT retornado autoriza chamadas subsequentes para a operação getOrderAddress para qualquer um dos IDs de pedido de um vendedor. Por exemplo, GET /orders/v0/orders/902-3159896-1390916/address e GET /orders/v0/orders/483-3488972-0896720/address.

ValorDescrição
Body

Obrigatório

Tipo: CreateRestrictedDataTokenRequest
Os detalhes da solicitação de token de dados restritos.

CreateRestrictedDataTokenRequest

O esquema de solicitação para a operação createRestrictedDataToken.

ValorDescrição
restrictedResources

Obrigatório

Tipo: < RestrictedResource > array
Uma lista de recursos restritos.
Máximo: 50

RestrictedResource

Modelo de recurso restrito.

ValorDescrição
method

Obrigatório

Tipo: enum (Method)
O método HTTP usado com o recurso restrito.
path

Obrigatório

Tipo: String
O caminho de uma operação restrita. Isto pode ser:

Um caminho específico contendo um ID de pedido do vendedor, por exemplo /orders/v0/orders/902-3159896-1390916/address.

Um caminho genérico que não contém um ID de pedido do vendedor, por exemplo /orders/v0/orders/{orderId}/address.

CreateRestrictedDataTokenResponse

O esquema de resposta para a operação createRestrictedDataToken.

ValorDescrição
restrictedDataToken

Obrigatório

Tipo: String
Um Token de Dados Restritos (RDT). Este é um token de acesso de curta duração que autoriza você a acessar os recursos restritos que você especificou. Passe esse valor com o cabeçalho x-amz-access-token ao fazer chamadas subsequentes para esses recursos restritos.
expiresIn

Opcional

Tipo: Integer

Method

O método HTTP usado com o recurso restrito.

Tipo: enum

ValorDescrição
GETO método GET.
PUTO método PUT.
POSTO método POST.
DELETEO método DELETE.