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.

​
Quickstart

Nippy tiene dos superficies de integración. Usa el SDK cuando tu producto necesita ejecutar mecánicas de gamificación. Usa MCP cuando un agente o cliente compatible necesita operar herramientas de Nippy.

​
SDK

El SDK es la ruta para integrar campañas, spins, claims y webhooks en tu aplicación.
1

Instala el SDK

npm install github:Nippy-Tech/gamification_nippy_sdk
2

Inicializa el cliente

import { NippyClient } from '@nippy/sdk'

const nippy = new NippyClient({
  apiKey: process.env.NIPPY_API_KEY,
  baseUrl: 'https://ms.nippy.la'
})
3

Ejecuta un spin

const result = await nippy.spin({
  userId: 'user-123',
  campaignId: 'camp-abc'
})

Quickstart completo del SDK

Crea una campaña de prueba, ejecuta un spin y recibe el webhook.

Referencia de métodos

Revisa track(), spin(), getState() y claim().

​
MCP

MCP es la ruta para conectar clientes como Claude Desktop, Cursor, OpenClaw o Hermes Agent al servidor de Nippy.
1

Consigue tu API key

Crea una key con prefijo npk_ desde la consola.
https://console.nippy.la/settings/api-keys
2

Configura el servidor MCP

Usa este endpoint en tu cliente MCP:
https://ms.nippy.la/cognitive-layer/mcp
3

Agrega el header de autenticación

{
  "headers": {
    "X-API-Key": "npk_tu_api_key_aqui"
  }
}

Quickstart completo de MCP

Configura Claude Desktop, Cursor, OpenClaw o Hermes Agent.

Tools disponibles

Consulta analytics, ruletas, flows, learning y supply.

​
Siguiente paso

Autenticación SDK

Revisa API keys y headers para llamadas desde tu aplicación.

Autenticación MCP

Revisa cómo autenticar clientes MCP con X-API-Key.