Saltar a contenido

Probar con Swagger

Swagger permite explorar y ejecutar la API de una instancia. Está disponible en <origen-api>/swagger si SWAGGER_ENABLED=true; el JSON generado está en <origen-api>/swagger/v1/swagger.json.

openapi.yaml del repositorio es el contrato HTTP canónico. El documento generado refleja la instancia y sirve para detectar una versión diferente o desactualizada.

Autorizar las llamadas

Pulsa Authorize:

Esquema Valor que debes introducir
bearerAuth Solo el token BC, sin el prefijo Bearer
deviceToken Token devuelto por activación

Swagger construye las cabeceras. POST /v1/devices/activate y GET /health no requieren credencial previa.

Probar el flujo manuscrito

  1. Ejecuta GET /health.
  2. Con bearer, registra una tablet de pruebas y emite su código.
  3. Actívala mediante deviceId/activationCode; guarda deviceToken y autorízalo.
  4. Crea la solicitud con bearer. El ejemplo de Swagger contiene un PDF de prueba válido; cambia deviceId por tu tablet registrada.
  5. Usa la PWA real para leer y firmar, o simula active → next → start-signing → signed con el token tablet.
  6. Con bearer, consulta estado y descarga resultado cuando esté signed.

Los marcadores <PDF_REAL_EN_BASE64> que aparecen en guías no son PDFs válidos. Sustitúyelos por datos reales o por el ejemplo prellenado de la instancia.

Probar PAdES y extracción

Para PAdES, prepare requiere Idempotency-Key, PDF y certificado público DER. La firma de toBeSignedBase64 debe producirse en BC o con una herramienta criptográfica autorizada; Swagger no accede a la clave privada aislada. La prueba más directa de la extensión es la página Sign PDF de BC.

En el esquema PreparePadesSignatureRequest, certificateBase64 es la hoja obligatoria y certificateChainBase64 es opcional: puedes omitirlo. El texto de los campos y de prepare explica la resolución automática independiente del emisor. UANATACA CA1 2021 y ROOT 2016 están incluidos en la imagen API desde 0.2.14, sin cargas/env/cambios BC adicionales; las descripciones de esquema visibles se corrigen en 0.2.15. Si no aparecen en /swagger/v1/swagger.json, comprueba la imagen API realmente desplegada; cambiar openapi.yaml o publicar MkDocs no cambia el Swagger de una instancia antigua.

Genera una operación nueva con el PDF original tras actualizar; los resultados anteriores no se reescriben. La cadena completa no garantiza confianza del lector y el perfil sigue sin TSA, revocación o B-T/LT/LTA. Consulta el ejemplo de hoja sola y los avisos del lector.

Para extracción de texto, envía PDF a pdf-text-extractions y comprueba text/requiresOcr. Para OCR, encola explícitamente y consulta el jobId.

Qué confirma esta herramienta

Swagger confirma rutas, autenticación y respuestas HTTP de esa instancia. La PWA real confirma interacción táctil; BC confirma conectividad cloud y permisos; un lector independiente confirma la firma del PDF.

Continúa con Ejemplos REST, Firma AL o Extracción.