API REST

Claves API

Usa una clave API personal para llamar a la API REST desde tus scripts.

Crear y revocar una clave

Inicia sesión en NinjaBuy y abre Cuenta → Referidos → Claves API para crear, consultar y revocar claves con nombre. La clave completa empieza por nb_ y se muestra una sola vez. Usa Copiar clave para guardarla de forma segura antes de cerrar el mensaje.

Una clave nunca caduca, salvo que elijas una duración al crearla: 30 días, 90 días o 1 año. La revocación o el fin de esa duración se aplica a la siguiente solicitud, y una clave caducada desaparece de la lista.

Solo se almacena un hash SHA-256 de la clave.

Usar una clave

Proporciona la clave a tu script como NINJABUY_API_KEY y envíala en el encabezado Authorization:

curl -sS https://www.ninjabuy.com/api/v1/links \
  -H "Authorization: Bearer $NINJABUY_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"links":["https://weidian.com/item.html?itemID=7581746714"]}'

El mismo encabezado funciona en todas las rutas REST autenticadas: Enlaces, Búsqueda, cargas y Hojas de cálculo, y Trabajos. El documento OpenAPI no requiere autenticación.

Permisos y límites

Todas las claves reciben los tres permisos. No hay un selector de permisos.

PermisoRutas
links:createPOST /api/v1/links, POST /api/v1/uploads, POST /api/v1/sheets
jobs:readGET /api/v1/jobs/{id}
search:readGET /api/v1/search

Las claves y las solicitudes REST con OAuth comparten las ventanas de creación y búsqueda de la cuenta. La creación de enlaces mediante MCP también comparte la ventana de creación. Consulta Límites de solicitudes.

Una clave no permite iniciar sesión, abrir una sesión ni llamar a MCP o a las API de la cuenta. Usa OAuth para una aplicación que actúe en nombre de otros clientes de NinjaBuy o un cliente MCP.

Errores

Una clave no válida, caducada o revocada devuelve el mismo problema 401 que un token OAuth no válido. Si el almacenamiento de claves no está disponible, devuelve 503 con Retry-After. Consulta Errores.