Ir al contenido
DevLab

Cómo funciona el SDK

Las dos mitades del SDK, sus dos modos, qué decides tú y por qué el navegador no lleva token.

En esta página
  1. Dos mitades
  2. Dos modos
  3. Ningún token en el navegador
  4. Qué decides tú
  5. Las páginas de este grupo

Preview 0.45 Disponible · Preview 0.45. La API puede cambiar antes de la 1.0: consulta las Fases de lanzamiento.

El SDK ejecuta la captura por ti: el protocolo, los steps, los lotes, el baseline y los resultados de la sesión. Tú construyes las pantallas y decides qué significa cada step.

El SDK son dos paquetes npm, uno por cada lado del cable:

  • En el navegador, @neurologyca/capture: el cliente en vivo (createProtocolClient) y, desde @neurologyca/capture/record, el cliente de grabación (createRecordingClient).
  • En tu backend, @neurologyca/capture-server: el proxy que añade el token (createEngineProxy), createEngineAdmin para personas, inscripciones y resultados y, para el diferido, el receptor de subidas (createUploadReceiver).
  1. Navegador@neurologyca/capture
  2. Tu backend@neurologyca/capture-server: proxy + token + admin + receptor
  3. Engine
El token vive solo en tu backend.
  • En el dispositivo (tiempo real): se procesa en el navegador mientras capturas. En capturas cortas, los resultados llegan durante la sesión y segundos después del último lote; las largas tardan minutos en cerrarse. El vídeo y el audio no salen del dispositivo; salen landmarks y datos de expresión hacia Engine y, solo si los activas, el transcrito y las señales extra. Lo limita el dispositivo: la detección de la cara en la GPU (WebGL 2) y, en móvil, el calor en sesiones largas.
  • Diferido (en servidor): el SDK graba el vídeo y un manifiesto de steps y los sube; nuestro servicio de procesado lo procesa poco después. No son horas: simplemente no se procesa en el dispositivo. Hoy puedes grabar, subir y procesar con el servicio de procesado de Neurologyca: nada que desplegar.

Cuál elegir y cómo combinar el SDK con la API HTTP: Vías de integración.

Tu página habla con tu backend, y el proxy de tu backend añade el token. Crea el cliente con la ruta de tu proxy y sin getToken:

JavaScript
import { createProtocolClient } from '@neurologyca/capture'
const client = createProtocolClient({ baseUrl: '/engine', taxonomy }) // tu proxy: ni key ni token en la página

Las pantallas y sus textos; el consentimiento antes de captureProtocol, y solo desde un gesto de la persona; quién cierra cada step y qué dice un step sin texto; quiénes son tus usuarios y qué ids puede tocar cada uno (authorize con ownsAll). El SDK y capture-server hacen las rutas de Engine, el token, los lotes, los reintentos y la reserva. La tabla completa está en Vías de integración.