Esquemas de datos: Autenticación

dataTokenData Obligatorio

Ejemplo de respuesta · TokenData.

Ejemplo: {"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 Obligatorio

Metadatos de la respuesta.

Ejemplo: {"request_id":"example"}

Campos adicionales: No

dataTokenRevokedData Obligatorio

Ejemplo de respuesta · TokenRevokedData.

Ejemplo: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorio

Metadatos de la respuesta.

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

Campos adicionales: No

access_tokenCadena de textoObligatorio

Token para la encabezado Authorization: Bearer. Define SHOPENTLY_ACCESS_TOKEN antes de ejecutar el ejemplo por separado.

Ejemplo: "EXAMPLE_ACCESS_TOKEN"

expires_atCadena de textoObligatorio

Fecha y hora de vencimiento en UTC. Las restricciones de acceso vigentes pueden bloquear el token antes.

format: "date-time"

Ejemplo: "2026-01-01T12:15:00Z"

expires_inNúmero enteroObligatorio

Duración real en segundos; este ejemplo solicita 1800. Las solicitudes no la prolongan. expires_at indica la caducidad en UTC.

minimum: 300maximum: 3600

Ejemplo: 1800

permissionsLista <Cadena de texto> Obligatorio

permissions muestra los permisos efectivos actuales: la intersección de los permisos de la clave, su autor y el plan de la tienda, incluidos los permisos activos de complementos. El acceso se comprueba en cada solicitud.

Ejemplo: ["orders.order:read"]

rate_limitsTokenRateLimitsData Obligatorio

Engine ≥ 4.143.0. Cada respuesta de token incluye data.rate_limits de la política de la tienda vigente al emitirlo. Todas las claves comparten estos presupuestos; un token nuevo no los reinicia. Un cambio de plan puede aplicarse antes de que caduque el token.

Ejemplo: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeCadena de textoOpcional

Bearer. Esquema de autenticación del token devuelto.

const: "Bearer"

Valor predeterminado: "Bearer"Ejemplo: "Bearer"

warningsLista <TokenLifetimeWarning > Obligatorio

Un entero fuera del rango aplica 900 segundos y devuelve warnings con token.ttl_out_of_range y documentation_url a learn.shopently.com. Omitir el campo no genera advertencias; un tipo inválido devuelve 422.

Ejemplo: []

Campos adicionales: No

applied_secondsNúmero enteroOpcional

900 s (15 min)

Valor predeterminado: 900

codeCadena de textoOpcional

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Valor predeterminado: "token.ttl_out_of_range"

documentation_urlCadena de textoOpcional

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

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

fieldCadena de textoOpcional

ttl_seconds

const: "ttl_seconds"

Valor predeterminado: "ttl_seconds"

max_secondsNúmero enteroOpcional

3600 s (60 min)

Valor predeterminado: 3600

messageCadena de textoOpcional

Un entero fuera del rango aplica 900 segundos y devuelve warnings con token.ttl_out_of_range y documentation_url a learn.shopently.com. Omitir el campo no genera advertencias; un tipo inválido devuelve 422.

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

min_secondsNúmero enteroOpcional

300 s (5 min)

Valor predeterminado: 300

Campos adicionales: No

auth_per_minuteNúmero enteroObligatorio

Solicitudes de emisión y revocación de tokens por minuto, incluidos los intentos fallidos de autenticación. Ambas operaciones comparten el límite auth.

minimum: 0maximum: 1000000

Ejemplo: 1

read_per_minuteNúmero enteroObligatorio

Solicitudes de lectura por minuto.

minimum: 0maximum: 1000000

Ejemplo: 2

write_per_minuteNúmero enteroObligatorio

Solicitudes de escritura por minuto; este valor no concede permisos de escritura.

minimum: 0maximum: 1000000

Ejemplo: 15

Campos adicionales: No

ttl_secondsNúmero enteroOpcional

Entero opcional ttl_seconds: 300–3600 segundos (5–60 minutos). Si se omite, se aplican 900 segundos (15 minutos).

Valor predeterminado: 900Ejemplo: 1800

Campos adicionales: No

access_tokenCadena de textoObligatorio

Envía POST /api/v1/auth/revoke con la clave emisora en Authorization: ApiKey y el token en el campo JSON access_token. Tras el éxito, el siguiente uso devuelve 401. Un token repetido, desconocido o ajeno recibe el mismo revoked: true; nunca se borran tokens de otras claves.

minLength: 1maxLength: 256

Ejemplo: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Campos adicionales: No

revokedBooleanoOpcional

Envía POST /api/v1/auth/revoke con la clave emisora en Authorization: ApiKey y el token en el campo JSON access_token. Tras el éxito, el siguiente uso devuelve 401. Un token repetido, desconocido o ajeno recibe el mismo revoked: true; nunca se borran tokens de otras claves.

const: true

Valor predeterminado: trueEjemplo: true

Campos adicionales: No