Saltar a contenido

API - Resumen

Base path principal: /v1

Autenticacion

  • BC: Authorization: Bearer <token>
  • Tablet: X-Device-Token: <token>
  • Activacion publica: deviceId + activationCode

Matriz de autenticacion

Actor Header Endpoints tipicos
BC Authorization: Bearer <token> POST /v1/devices, DELETE /v1/devices/{deviceId}, POST /v1/signature-requests, GET /v1/signature-requests, GET /v1/signature-requests/{requestId}
Tablet activada X-Device-Token: <token> GET /v1/devices/{deviceId}/active, GET /v1/devices/{deviceId}/next, POST /v1/signature-requests/{requestId}/signed
Activacion publica sin header POST /v1/devices/activate

Endpoints principales

BC

  • GET /v1/devices
  • POST /v1/devices
  • DELETE /v1/devices/{deviceId}
  • POST /v1/devices/{deviceId}/activation-code
  • POST /v1/devices/{deviceId}/revoke
  • POST /v1/signature-requests
  • GET /v1/signature-requests
  • GET /v1/signature-requests/{requestId}
  • POST /v1/signature-requests/{requestId}/cancel
  • GET /v1/signature-requests/{requestId}/result

Tablet

  • POST /v1/devices/activate
  • GET /v1/devices/{deviceId}/active
  • GET /v1/devices/{deviceId}/next
  • POST /v1/signature-requests/{requestId}/start-signing
  • POST /v1/signature-requests/{requestId}/signed
  • POST /v1/devices/{deviceId}/signature-requests/{requestId}/cancel

Operacion

  • GET /health

Gestion de tablets

  • revoke desactiva una tablet y borra su token/codigo, pero conserva el registro para reactivarla despues.
  • DELETE /v1/devices/{deviceId} elimina el registro de la tablet si no tiene solicitudes abiertas.
  • La eliminacion no borra solicitudes, PDFs ni auditoria historica; el deviceId queda en las solicitudes como trazabilidad.
  • Si existen solicitudes pending, displayed o signing, la eliminacion devuelve 409 CONFLICT.

Activacion y sesion de tablet

  • El codigo de activacion es temporal, tiene 6 digitos numericos y se usa una sola vez para obtener un deviceToken.
  • La PWA guarda el token en localStorage; recargar la pagina o reiniciar la tablet no pierde la activacion.
  • La activacion se pierde si se borran datos del navegador/PWA, se desinstala la app, se emite un nuevo codigo, se revoca o se elimina el dispositivo.
  • En espera, la tablet muestra una pantalla limpia de recepcion con Esperando documento y mantiene el polling.

Herramientas de integracion