Saltar al contenido principal

Inicio rápido

Comienza a usar el SDK de JavaScript de Heuristik en minutos.

Requisitos previos​

  • Escáner de huellas (proporcionado por Heuristik)
  • Driver local instalado y en ejecución (proporcionado por Heuristik)
  • Credenciales de API: apiKey, apiSecret y UUID de tenant (proporcionados por Heuristik)
  • Node.js 24.8.0 o un navegador moderno

Gestores de paquetes​

GestorVersión mínima
npm≥ 11.0
yarn≥ 1.22
pnpm≥ 9.0
NavegadorVersión mínima
Chrome≥ 80
Edge≥ 80
Firefox≥ 74
Opera≥ 67

Configuración del registro​

El SDK se publica en un registro privado. Agrega un archivo .npmrc en la raíz de tu proyecto:

@heuristik:registry=https://npm.heuristik.link/

Instalación​

npm install @heuristik/hhjssdk

Formatos de módulo​

El SDK incluye formatos de módulo duales y declaraciones TypeScript:

FormatoPunto de entradaUso
ES Modulesdist/index.esm.jsimport { HeuristikClient } from '@heuristik/hhjssdk'
CommonJSdist/index.cjsconst { HeuristikClient } = require('@heuristik/hhjssdk')
TypeScriptdist/types/index.d.tsDeclaraciones de tipos completas incluidas

El paquete usa exportaciones condicionales — tu bundler o entorno de ejecución resolverá el formato correcto automáticamente.

Cómo funciona​

Ejemplo mínimo​

import { HeuristikClient, setStorageProvider } from '@heuristik/hhjssdk';

// ⚠️ Para producción, usa cookies HttpOnly en lugar de localStorage
setStorageProvider({
  getItem: async (k) => localStorage.getItem(k),
  setItem: async (k, v) => localStorage.setItem(k, v),
  removeItem: async (k) => localStorage.removeItem(k),
});

const client = new HeuristikClient({
  apiBase: 'https://api.example.com/public/v1',
  apiKey: 'your-api-key',
  apiSecret: 'your-api-secret',
  tenant: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  country: 'CO',
});

// Autenticar y cargar los tokens almacenados
await client.init();

// Identificar a una persona por huella dactilar (índice de dedo 1 = índice derecho)
const result = await client.operations.identifyPerson(1);
console.log('Identified:', result);

// Limpiar al terminar
await client.logout();
Soporte TypeScript

El SDK está escrito en TypeScript e incluye declaraciones de tipos completas. Todos los tipos se exportan desde el paquete principal @heuristik/hhjssdk.

Siguientes pasos​