API - Guia rapida BC
Esta pagina es la entrada recomendada para el desarrollador de Business Central.
URLs de pruebas
- API base URL:
https://apifirma.jdmarquez.dev
- Swagger UI:
https://apifirma.jdmarquez.dev/swagger
- OpenAPI JSON:
https://apifirma.jdmarquez.dev/swagger/v1/swagger.json
- tablet de pruebas:
https://tabletfirma.jdmarquez.dev/
Lo que necesitas para empezar
BC_BEARER_TOKEN valido
- una extension AL con
HttpClient habilitado
- capacidad para convertir el PDF a Base64 antes de llamar a la API
- un
deviceId de tablet existente o uno nuevo que vayas a registrar
Autenticacion
| Actor |
Header |
Uso |
| Business Central |
Authorization: Bearer <BC_BEARER_TOKEN> |
registrar tablets, emitir codigos, crear solicitudes, consultar estado, descargar resultado |
| Tablet activada |
X-Device-Token: <DEVICE_TOKEN> |
active, next, start-signing, signed, cancelacion desde tablet |
| Activacion publica de tablet |
sin header |
deviceId + activationCode |
Flujo minimo para BC
- Registrar la tablet con
POST /v1/devices si todavia no existe.
- Emitir codigo con
POST /v1/devices/{deviceId}/activation-code cuando la tablet se instala o se resetea.
- Crear la solicitud con
POST /v1/signature-requests enviando pdfBase64 y deviceId.
- Consultar el estado con
GET /v1/signature-requests/{requestId} hasta llegar a signed, cancelled o expired.
- Descargar el PDF final con
GET /v1/signature-requests/{requestId}/result.
Endpoints que normalmente usa BC
| Objetivo |
Endpoint |
| Listar tablets |
GET /v1/devices |
| Registrar tablet |
POST /v1/devices |
| Emitir codigo |
POST /v1/devices/{deviceId}/activation-code |
| Revocar tablet |
POST /v1/devices/{deviceId}/revoke |
| Crear solicitud |
POST /v1/signature-requests |
| Consultar estado |
GET /v1/signature-requests/{requestId} |
| Cancelar solicitud |
POST /v1/signature-requests/{requestId}/cancel |
| Descargar PDF firmado |
GET /v1/signature-requests/{requestId}/result |
Orden de lectura recomendado
- API - Resumen
- API - Business Central
- API - Errores de integracion
- API - Swagger
- API - Ejemplos
Checklist rapido antes de integrar
- confirmar que
GET /health responde ok
- probar
POST /v1/devices desde Swagger o Postman con el bearer token
- validar que el token BC se guarda fuera del frontend
- registrar
traceId en logs de BC cuando una llamada falle