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.
Overview
Documentación para integrar productos con Nippy. Usa el SDK para ejecutar mecánicas de gamificación desde tu aplicación, o conecta un cliente MCP para consultar y operar herramientas internas con lenguaje natural.Secciones principales
SDK de gamificación
Integra campañas, spins, claims, webhooks y manejo de errores desde tu backend o frontend.
MCP
Conecta clientes compatibles con MCP para consultar analytics, ruletas, flows, learning y supply.
Empieza rápido
SDK
Instala el SDK, inicializa el cliente y ejecuta un spin.
MCP
Configura un cliente MCP con el endpoint de Nippy y tu API key.
Referencia del SDK
track()
Envía eventos de negocio y deja que Nippy evalúe reglas de campaña.
spin()
Ejecuta un giro inmediato y recibe el resultado de forma síncrona.
getState()
Consulta elegibilidad, cooldowns, spins restantes y claims pendientes.
claim()
Confirma premios físicos o digitales que requieren reclamación explícita.
Operación y soporte
Autenticación
Configura API keys y headers requeridos para llamadas del SDK y API pública.
Webhooks
Verifica firmas y procesa eventos emitidos por Nippy.
Errores del SDK
Revisa códigos de error, causas y patrones de manejo.
Errores MCP
Diagnostica errores comunes al usar el servidor MCP.
Para credenciales y acceso a la consola, usa una API key con prefijo
npk_. No la incluyas en repositorios ni clientes públicos.