Esquemas de datos: Autenticación

Esquemas de datos: Autenticación. Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

Esquemas de datos

Obtener · Token — Autenticación — Respuesta

ApiResponse_TokenData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataTokenData Obligatorio: Ejemplo de respuesta · TokenData.

Ejemplo: {"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 Obligatorio: Metadatos de la respuesta.

Ejemplo: {"request_id":"example"}

Campos adicionales: No

Obtener · Token — Autenticación — Respuesta

TokenData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

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:00:00Z"
expires_inNúmero enteroOpcional: 900 segundos, es decir, 15 minutos desde su emisión. Las solicitudes no prolongan su validez.

Valor predeterminado: 900Ejemplo: 900
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":10,"read_per_minute":60,"write_per_minute":10}
token_typeCadena de textoOpcional: Bearer. Esquema de autenticación del token devuelto.

const: "Bearer"

Valor predeterminado: "Bearer"Ejemplo: "Bearer"

Campos adicionales: No

Límites de solicitudes

TokenRateLimitsData · 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. Cero significa no disponible, no ilimitado.

auth_per_minuteNúmero enteroObligatorio: Solicitudes de token por minuto, incluidos los intentos de autenticación fallidos.

minimum: 0maximum: 1000000

Ejemplo: 10
read_per_minuteNúmero enteroObligatorio: Solicitudes de lectura por minuto.

minimum: 0maximum: 1000000

Ejemplo: 60
write_per_minuteNúmero enteroObligatorio: Solicitudes de escritura por minuto; este valor no concede permisos de escritura.

minimum: 0maximum: 1000000

Ejemplo: 10

Campos adicionales: No

Obtener · Token — Autenticación — Cuerpo de la solicitud

TokenRequest · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

ObjetoCampos adicionales: No

Campos adicionales: No