Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.nippy.la/llms.txt

Use this file to discover all available pages before exploring further.

​
Métodos de autenticación

El servidor MCP y los endpoints REST de Nippy soportan dos métodos de autenticación. Ambos resuelven el business_id del tenant automáticamente — nunca necesitas pasarlo explícitamente en las llamadas a tools.

​
X-API-Key (recomendado)

Incluye tu Nippy API Key en el header X-API-Key de cada petición: 
POST /mcp
X-API-Key: npk_tu_api_key_aqui
Content-Type: application/json
Las keys con prefijo npk_* son keys de tenant. El servidor las resuelve contra la base de datos para determinar qué business_id autorizas, sin exponer ese ID en la petición.

​
OAuth Bearer JWT

Para clientes que implementan el protocolo completo de OAuth, el servidor expone un endpoint de intercambio de tokens: 
POST /oauth/token
Content-Type: application/json

{
  "grant_type": "client_credentials",
  "client_id": "tu_client_id",
  "client_secret": "npk_tu_api_key_aqui"
}
La respuesta incluye un access_token que puedes usar como Bearer: 
POST /mcp
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Para la mayoría de integraciones con Claude Desktop y Cursor, usa directamente X-API-Key. El flujo OAuth es para clientes MCP que implementan el protocolo de autenticación completo.

​
Cómo obtener tu API key

Las API keys se generan desde la Consola de Nippy:
  1. Inicia sesión en https://console.nippy.la
  2. Ve a Configuración > API Keys
  3. Haz clic en Generar nueva key
  4. Copia la key (formato npk_xxxxxxxx)
Nunca compartas tu npk_* key. Tiene acceso completo de lectura y escritura a los datos de tu negocio. Si una key se compromete, revócala inmediatamente desde la Consola.

​
Aislamiento multi-tenant

Cada API key está ligada a exactamente un negocio. El servidor garantiza que:
  1. Todas las tools filtran datos por el business_id resuelto de la key — no puedes consultar datos de otro negocio aunque conozcas su ID.
  2. Analytics tiene doble capa de seguridad: el servidor garantiza que solo ves los datos de tu negocio, sin importar cómo esté formulada la consulta.
  3. Roulettes, Supply, Learning, Flows filtran automáticamente por tu negocio en cada operación.

​
Errores de autenticación

CódigoMensajeCausa
401UnauthorizedHeader X-API-Key ausente, inválido o malformado
403ForbiddenKey válida pero sin permisos para el recurso solicitado
400ValueError: MCP tools require tenant-bound auth (npk_* key or OAuth Bearer)La key no está ligada a un tenant (no es una key npk_*)
Si recibes un error de autenticación, verifica que:
  • El header se llama X-API-Key (no Authorization, no x-api-key sin guiones)
  • La key tiene el prefijo npk_
  • La key no ha expirado ni sido revocada en la Consola