Skip to content

Overview ​

El SDK oficial de Nimobase es la forma recomendada de consumir la API REST: clientes tipados, errores coherentes y autenticación según dónde corra tu código. Envuelve la API completa — ya pagina y traduce los errores por ti — desde tu servidor o desde el navegador de tus usuarios, sin exponer secretos.

¿Dónde corre tu código? ​

DóndeCredencialPaquete
En tu servidor (backend, scripts, jobs)Clave secreta sk_@nimobase/sdk/node
En el navegador (SPA, widget embebido)Clave publicable pk_ + JWT de usuario@nimobase/sdk/browser

El paquete de TypeScript es el mismo para las dos superficies: cambia solo el import (@nimobase/sdk/node o @nimobase/sdk/browser). Si la integración corre en un servidor y prefieres Python, existe un SDK de Python.

Nunca expongas claves secretas

Las claves sk_ no deben usarse en navegadores ni apps móviles. El SDK browser rechaza sk_ en la inicialización (fail-fast) y el SDK server rechaza pk_. Las claves se crean y gestionan en API Keys.

Instalación ​

El paquete se publica en GitHub Packages, no en npm público. Primero crea un PAT de GitHub con el scope read:packages y declara el registro en el .npmrc de tu proyecto:

bash
# .npmrc del proyecto
@nimobase:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}

npm install @nimobase/sdk

NODE_AUTH_TOKEN es una variable de entorno que contiene el PAT. Sin ese token el npm install falla: GitHub Packages no sirve paquetes sin autenticación.

Continúa aquí ​

Después de entender qué es el SDK y cómo se instala, sigue con el SDK de TypeScript o con el SDK de Python, según dónde corra tu integración. Y cuando quieras ver qué puede hacer cada una de esas superficies, el índice completo de capacidades está en Funcionalidades y métodos.