Esquemas de dados: Autenticação

dataTokenData Obrigatório

Exemplo de resposta · TokenData.

Exemplo: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:15:00Z","expires_in":1800,"permissions":["orders.order:read"],"rate_limits":{"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15},"token_type":"Bearer","warnings":[]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obrigatório

Metadados da resposta.

Exemplo: {"request_id":"example"}

Campos adicionais: Não

dataTokenRevokedData Obrigatório

Exemplo de resposta · TokenRevokedData.

Exemplo: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obrigatório

Metadados da resposta.

Exemplo: {"request_id":"example-request"}

Campos adicionais: Não

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:15:00Z"

expires_inNúmero inteiroObrigatório

Duração real em segundos; este exemplo pede 1800. Os pedidos não a prolongam. expires_at indica a expiração em UTC.

minimum: 300maximum: 3600

Exemplo: 1800

permissionsLista <Texto> Obrigatório

permissions apresenta as permissões efetivas atuais: a interseção das permissões da chave, do seu autor e do plano da loja, incluindo permissões de extensões ativas. O acesso é verificado em cada pedido.

Exemplo: ["orders.order:read"]

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":1,"read_per_minute":2,"write_per_minute":15}

token_typeTextoOpcional

Bearer. Esquema de autenticação do token retornado.

const: "Bearer"

Predefinido: "Bearer"Exemplo: "Bearer"

warningsLista <TokenLifetimeWarning > Obrigatório

Um inteiro fora do intervalo aplica 900 segundos e devolve warnings com token.ttl_out_of_range e documentation_url para learn.shopently.com. Omitir o campo não gera avisos; um tipo inválido devolve 422.

Exemplo: []

Campos adicionais: Não

applied_secondsNúmero inteiroOpcional

900 s (15 min)

Predefinido: 900

codeTextoOpcional

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Predefinido: "token.ttl_out_of_range"

documentation_urlTextoOpcional

https://learn.shopently.com/en/api/docs/authentication/#token-lifetime

Predefinido: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldTextoOpcional

ttl_seconds

const: "ttl_seconds"

Predefinido: "ttl_seconds"

max_secondsNúmero inteiroOpcional

3600 s (60 min)

Predefinido: 3600

messageTextoOpcional

Um inteiro fora do intervalo aplica 900 segundos e devolve warnings com token.ttl_out_of_range e documentation_url para learn.shopently.com. Omitir o campo não gera avisos; um tipo inválido devolve 422.

Predefinido: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsNúmero inteiroOpcional

300 s (5 min)

Predefinido: 300

Campos adicionais: Não

auth_per_minuteNúmero inteiroObrigatório

Pedidos de emissão e revogação de tokens por minuto, incluindo tentativas de autenticação falhadas. Ambas as operações partilham o limite auth.

minimum: 0maximum: 1000000

Exemplo: 1

read_per_minuteNúmero inteiroObrigatório

Pedidos de leitura por minuto.

minimum: 0maximum: 1000000

Exemplo: 2

write_per_minuteNúmero inteiroObrigatório

Pedidos de escrita por minuto; este valor não concede permissões de escrita.

minimum: 0maximum: 1000000

Exemplo: 15

Campos adicionais: Não

ttl_secondsNúmero inteiroOpcional

Inteiro opcional ttl_seconds: 300–3600 segundos (5–60 minutos). Se omitido, aplica-se o valor predefinido de 900 segundos (15 minutos).

Predefinido: 900Exemplo: 1800

Campos adicionais: Não

access_tokenTextoObrigatório

Envie POST /api/v1/auth/revoke com a chave emissora em Authorization: ApiKey e o token no campo JSON access_token. Após o sucesso, a utilização seguinte devolve 401. Tokens repetidos, desconhecidos ou alheios recebem o mesmo revoked: true; os tokens de outras chaves nunca são eliminados.

minLength: 1maxLength: 256

Exemplo: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Campos adicionais: Não

revokedBooleanoOpcional

Envie POST /api/v1/auth/revoke com a chave emissora em Authorization: ApiKey e o token no campo JSON access_token. Após o sucesso, a utilização seguinte devolve 401. Tokens repetidos, desconhecidos ou alheios recebem o mesmo revoked: true; os tokens de outras chaves nunca são eliminados.

const: true

Predefinido: trueExemplo: true

Campos adicionais: Não