Preparación del Lote

Actualizado: 18-ago-2022

• Método: POST
• Seguridad: Basic Auth
• Servicio: /api/rest/services/prepareparallelsignature
• Content-Type:application/json

REQUEST

En el body de la request incluiremos JSON con la siguiente estructura.

{
  "sessionId": "string",
  "fileCount" : 0
}

Donde:

• sessionId: (obligatorio) (string) permite identificar la sesión desde la que se realiza la solicitud para ser utilizado en la redirección realizada tras la finalización de la operación.
• fileCount: (obligatorio) (int) indica el número total de ficheros que formarán parte del lote. Este número es importante conocerlo a priori para permitir que VIAFIRMA DESKTOP pueda ser lanzado por protocolo, a partir de un operationId asociado al lote, y pueda informar al usuario final del estado en tiempo real de la operación durante la fase de preparación y la fase de firma. Por ejemplo: "Preparando firma 75/100 documentos" / "Firmando documento 75/100".

A continuación otros parámetros, todos ellos OPCIONALES:

• autoSend: (opcional); cuando el usuario final solo tiene un único certificado, y este param vale true, VIAFIRMA DESKTOP omitará la pantalla en la que el usuario debe seleccionar su certificado, auto-seleccionándose para comenzar la operación de firma. En caso de que la solicitud incluya filtros de cualquier índole, se deben cumplir los criterios de validación definidos y que únicamente un certificado lo cumpla. Si los criterios lo cumplen más de un certificado, el autoSend no tendrá efecto. Por ejemplo, "mostrar todos los certificados de la FNMT".
• certFilter: (opcional) filtros que aplicará VIAFIRMA DESKTOP para mostrar la lista de certificados aptos para firmar. Se permite la siguiente configuración de filtros.
  • operator: (opcional)(string) lista de valores disponibles: "CONTAINS"
  • filterValues: (obligatorio) lista de valores que queremos incluir en el operador. Por ejemplo, número de DNI.
• locale: (opcional)(string) permite forzar la apertura de VIAFIRMA DESKTOP en el idioma especificado. En caso de indicar uno no soportado se mostrará en el idioma por defecto.

Ejemplo:

{
  "autoSend": true,
  "certFilter": {
      "operator": "CONTAINS",
      "filterValues": ["11111111H"]
  },
  "files": [],
  "locale": "es",
  "sessionId": "72828828A900000000000009",
  "fileCount" : 25
}

RESPONSE

Response 200 OK obtenemos JSON en el body de la response con la siguiente estructura.

{
    "operationId": "string"
}

• operationId : identificador generado por Viafirma Platform, necesario para los siguientes pasos en los que se agregarán los documentos que formarán parte de lote.

• Para errores asociados a credenciales obtendremos un 401
• Para errores asociados a una mala parametrización del JSON enviado en la request obrendremos una Response 400 Bad Request.
• Para el resto de respuestas de errores no controlados obtendremos una Response 500 Server Error.