Skip to content
API · Autenticación

Personal Access Tokens y scopes

Cómo autenticar sus requests y limitar el alcance de cada token.

Generar un token

Los Personal Access Tokens (PAT) se crean desde el panel de su tienda:

  1. Inicie sesión en su panel de admin.
  2. Vaya a Configuración → API Tokens.
  3. Haga clic en Crear token.
  4. Asigne un nombre y marque los permisos que necesita.
  5. Copie y guarde el token mostrado — solo se muestra una vez.

Cada token tiene la forma:

nvl_live_a4f2c8e1b3d7…

Usar el token en sus requests

Envíe el token en el header Authorization de cada request:

curl https://api.nuvlyx.com/api/v1/external/orders \
  -H "Authorization: Bearer nvl_live_a4f2c8e1b3d7…"

JavaScript / Node

const r = await fetch("https://api.nuvlyx.com/api/v1/external/orders", {
  headers: { Authorization: `Bearer ${process.env.NUVLYX_TOKEN}` }
});
const orders = await r.json();

Python

import os, requests

r = requests.get(
    "https://api.nuvlyx.com/api/v1/external/orders",
    headers={"Authorization": f"Bearer {os.environ['NUVLYX_TOKEN']}"},
)
orders = r.json()

Scopes disponibles

Un scope es un permiso atómico que se concede al token. Si su token no tiene el scope que un endpoint requiere, la API responde 403 Forbidden.

ScopePermite
products:readListar productos y variaciones.
products:writeCrear y actualizar productos.
inventory:readConsultar inventario y stock.
inventory:writeCargar licencias y mover stock.
orders:readLeer pedidos y su estado.
orders:writeCrear pedidos en nombre de clientes.
customers:readLeer clientes y sus datos.
customers:writeCrear y actualizar clientes. (próximamente)
wallet:readConsultar saldo del monedero.
wallet:writeRecargar el monedero de clientes.
webhooks:manageAdministrar endpoints de webhooks.

Buenas prácticas de seguridad

  • Use scopes mínimos: si su bot solo lee pedidos, no le ponga wallet:write.
  • Guarde el token en variables de entorno, nunca en código versionado.
  • Rote tokens periódicamente: cree uno nuevo y revoque el anterior una vez migre la integración.
  • Revoque inmediatamente si sospecha que un token se filtró. La acción es irreversible.
  • Use HTTPS siempre. La API rechaza peticiones HTTP planas.

Errores de autenticación

StatusCuándo ocurre
401Token faltante, mal formado, revocado o expirado.
403El token es válido pero le faltan scopes para esta ruta.
401La tienda dueña del token está suspendida.