🚧 La documentacion de Bloque está en desarrollo
Before this
  • Node.js 22+, Bun 1+, o Deno
After this2 min
  • SDK instalado
  • Imports con tipos

Instalar

Agrega el SDK a tu proyecto.

npm
yarn
pnpm
bun
deno
npm add @bloque/sdk
Verificar: el import resuelve sin errores
import { SDK } from '@bloque/sdk' // Sin error = listo

Opciones de configuración

OpciónTipoPor defectoDescripción
authAuthStrategyRequerido. Método de auth: apiKey, originKey, o jwt
originstringRequerido para auth originKey y jwt
mode'production' | 'sandbox''production'Usa 'sandbox' para pruebas
platform'node' | 'bun' | 'deno' | 'browser' | 'react-native''node'Entorno de ejecución
timeoutnumber30000Timeout de solicitud en milisegundos
retry.enabledbooleantrueAuto-reintento en 429, 503, errores de red
retry.maxRetriesnumber3Máximo de intentos
tokenStorageTokenStoragelocalStorageAlmacenamiento JWT — requerido para react-native

Estrategias de auth en resumen

apiKey — para servicios backend. Usa una clave secreta sk_live_ o sk_test_. El SDK la intercambia automáticamente por un JWT de corta duración.

new SDK({ auth: { type: 'apiKey', apiKey: process.env.BLOQUE_API_KEY! } })

originKey — para backends que gestionan identidades de usuarios directamente. Registra y conecta usuarios en tu Origen.

new SDK({
  origin: 'tu-origen',
  auth: { type: 'originKey', originKey: process.env.BLOQUE_ORIGIN_KEY! },
})

jwt — para apps de navegador y React Native donde los usuarios se autentican directamente.

new SDK({
  origin: 'tu-origen',
  auth: { type: 'jwt' },
  platform: 'browser',
})
Mantén las claves fuera del código cliente

Nunca expongas valores sk_ u originKey en código de navegador o React Native. Usa variables de entorno en el backend.


¿Qué sigue?

Registrar — crea identidades en tu Origen