Esquemas de dados: Autenticação

Esquemas de dados: Autenticação. Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

Esquemas de dados

Obter · Token — Autenticação — Resposta

ApiResponse_TokenData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataTokenData Obrigatório: Exemplo de resposta · TokenData.

Exemplo: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:00:00Z","expires_in":900,"rate_limits":{"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10},"token_type":"Bearer"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"request_id":"example"}

Campos adicionais: Não

Obter · Token — Autenticação — Resposta

TokenData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

access_tokenTextoObrigatório: Token para o cabeçalho Authorization: Bearer. Defina SHOPENTLY_ACCESS_TOKEN antes de executar o exemplo separado.

Exemplo: "EXAMPLE_ACCESS_TOKEN"
expires_atTextoObrigatório: Data e hora de expiração em UTC. As restrições de acesso atuais podem bloquear o token mais cedo.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
expires_inNúmero inteiroOpcional: 900 segundos, ou seja, 15 minutos após a emissão. Os pedidos não prolongam a validade.

Predefinido: 900Exemplo: 900
rate_limitsTokenRateLimitsData Obrigatório: Engine ≥ 4.143.0. Cada resposta de token inclui data.rate_limits da política da loja no momento da emissão. Todas as chaves partilham estes limites; um novo token não os repõe. Uma alteração de plano pode aplicar-se antes de o token expirar.

Exemplo: {"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10}
token_typeTextoOpcional: Bearer. Esquema de autenticação do token retornado.

const: "Bearer"

Predefinido: "Bearer"Exemplo: "Bearer"

Campos adicionais: Não

Limites de requisições

TokenRateLimitsData · Engine ≥ 4.143.0. Cada resposta de token inclui data.rate_limits da política da loja no momento da emissão. Todas as chaves partilham estes limites; um novo token não os repõe. Uma alteração de plano pode aplicar-se antes de o token expirar. Zero significa indisponível, não ilimitado.

auth_per_minuteNúmero inteiroObrigatório: Pedidos de token por minuto, incluindo tentativas de autenticação falhadas.

minimum: 0maximum: 1000000

Exemplo: 10
read_per_minuteNúmero inteiroObrigatório: Pedidos de leitura por minuto.

minimum: 0maximum: 1000000

Exemplo: 60
write_per_minuteNúmero inteiroObrigatório: Pedidos de escrita por minuto; este valor não concede permissões de escrita.

minimum: 0maximum: 1000000

Exemplo: 10

Campos adicionais: Não

Obter · Token — Autenticação — Corpo da requisição

TokenRequest · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

ObjetoCampos adicionais: Não

Campos adicionais: Não