Preparación del Lote

Actualizado: 05-sep-2023

• 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".

Params opcionales

• autoSend: (boolean) por defecto false, y permite auto-seleccionar un certificado digital en Viafirma Desktop en aquellos casos en los que únicamente existe un certificado, bien porque es el único instalado o bien porque es el único que cumple los criterios de filtro definidos en la request.
• locale: (string) permite forzar la apertura de Viafirma Desktop en un idioma específico. En caso de no informar locale o informar un locale no soportado se mostrará en el idioma por defecto, "es". Los locales admitidos son:

Filtro de Certificados

Viafirma Desktop permite filtrar la lista de certificados mostrados al usuario a partir de los criterios de filtrado que pueden ser incluidos en el payload de la request. Los filtros son opcionales, y se pueden usar de la siguiente forma:

• certFilter: el filtro se aplica sobre las propiedades del certificado
• caFilter: el filtro se aplica sobre las propiedades de la CA que emite el certificado
• numberUserIdFilter: el filtro se aplica sobre la propiedad numberUserId del certificado, utilizado de forma general por Viafirma para identificar el atributo OID del certificado en el que se informa le ID del titular, por ejemplo el DNI.
  • operator: (string) (obligatorio) valores permitidos: equals,contains,starts_with,ends_with.
  • filterValues: (string array) (obligatorio) valores pasados a cada filtro. En caso de pasar varios valores, se aplicará una condición "OR" entre ellos.

  "certFilter": {
      "operator": "contains",
      "filterValues": [
        "string",
        "string",
        "string"
        ]
  },
  "caFilter": {
      "operator": "contains",
      "filterValues": [
        "string",
        "string",
        "string"
        ]
  },
  "numberUserIdFilter": {
      "operator": "contains",
      "filterValues": [
        "string",
        "string",
        "string"
        ]
  }

Ejemplo con filtros:

{
  "sessionId": "2a5c4936-4c13-11ee-be56-0242ac120002",
  "fileCount" : "10",
  "certFilter": {
      "operator": "contains",
      "filterValues": ["JOHN DOE"]
  },
  "caFilter": {
      "operator": "contains",
      "filterValues": ["FNMT"]
  },
  "numberUserIdFilter": {
      "operator": "contains",
      "filterValues": ["11111111H"]
  }
}

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.