A continuación se de detalla cada uno de los servicios de los cuales dispone la API Rest de SIFE

1.- Servicios

Todos los servicios del API están autenticados. Se requiere un código de aplicación y una contraseña

Se utiliza la autentificación estándar HTTP. La autenticación se envía en la cabecera Authorization de la petición HTTP concatenando a "BasicX" el codigo de aplicación, el caracter : y la contraseña codificados en Base64

Por ejemplo,

1.1.- Digital Signature Service

Conjunto de métodos que permiten realizar operaciones de firma electrónica, firmar, elevar una firma, validar certificado, validar una firma, validar un timestamp, etc. Se trata de un servicio REST que se encuentra disponible en ${Base_URL}/v1/dss/

1.1.1.- Metodo 'extendSignature”

Open

Método que eleva la firma que se le pasa como parámetro a un nivel superior, por ejemplo de CAdES-B a CAdES-T o CAdES-A.

Se debe enviar la firma a elevar, el nivel deseado, y en caso de firmas detached el documento original.

Como ocurre en el caso de la firma, en el caso de que se trate de una firma detached, se puede realizar su elevación a partir del documento original completo, a través del Hash del documento o con su CSV.

En el caso de que realice a través del CSV el contenido del documento almacenado en sifeDocument.setData(originalDocument) y sifeDocument.setDigestValue(originalDocumentHash) será ignorado. 

El método 'extendSignature' no modificará los datos almacenados en CCSV en ningún momento, únicamente realizará la elevación y devolverá el resultado.

Petición

Para invocar correctamente al este método, es necesario tener en cuenta las siguiente consideraciones.

• Tanto para el atributo “signature” como para el atributo “detachedContent” en el caso de que se establezca un CSV, se va a intentar cargar la información de la firma y del documento desde el repositorio documental respectivamente. En el caso de que no exista se producirá un error

• Para el atributo “signature”, en el caso de no indicar CSV, es obligatorio completar los valores de “data”. Si esto no se hace se devolverá un error.

• El atributo detachedContent es opcional, únicamente se completará si se está intentando realizar la elevación de una firma detached. En cuyo caso es necesario completar,

  • Si se utiliza el documento completo para la elevación, el valor de “data”

  • Si se utiliza el hash del documento, el valor de “digestValue” y “digestAlgorithm”.

Respuesta

En el caso de que la operación se realice de forma satisfactoria, SIFE devolverá un código 200 y el cuerpo de la respuesta tendrá la siguiente estructura

En el caso de que se produzca un error se mandará como código de respuesta un código de error siguiendo el protocolo http y la cuerpo de la respuesta será el siguiente

No todos los errores están controlados y se manda como respuesta con estructura JSON. A la hora de procesar la respuesta hay que tener esto en cuenta.

Ejemplos de invocación

A continuación se muestran ejemplos de invocación al método, en concreto se muestra el JSON que debe contener el body de la llamada POST.

1.1.2.- Metodo 'validateSignature”

Open

Verifica una firma contra @firma. Se debe enviar la firma a verificar y el documento original si la firma es detached. Este método puede invocarse pasando como parámetro el contenido completo del documento, a través de su hash o indicando su CCSV.

Se devolverá un informe de verificación con el resultado, indicando si la firma es válida, o si la firma es inválida o la razón por la cual no se ha verificado correctamente la firma.

Petición

Para invocar correctamente al este método, es necesario tener en cuenta las siguiente consideraciones.

• Tanto para el atributo “signature” como para el atributo “detachedContent” en el caso de que se establezca un CSV, se va a intentar cargar la información de la firma y del documento desde el repositorio documental respectivamente. En el caso de que no exista se producirá un error

• Para el atributo “signature”, en el caso de no indicar CSV, es obligatorio completar los valores de “data”. Si esto no se hace se devolverá un error.

• El atributo detachedContent es opcional, únicamente se completará si se está intentando realizar la validación de una firma detached. En cuyo caso es necesario completar,

  • Si se utiliza el documento completo para la elevación, el valor de “data”

  • Si se utiliza el hash del documento, el valor de “digestValue” y “digestAlgorithm”.

Respuesta

En el caso de que la operación se realice de forma satisfactoria, SIFE devolverá un código 200 y el cuerpo de la respuesta tendrá la siguiente estructura

Para obtener más información a cerca de cada uno de los atributos devueltos en la respuesta de la verificación ver el apartado 2.

En el caso de que durante la ejecución de la operación se produzca algún error, SIFE devolverá un código de error siguiendo el protocolo http y el cuerpo de la respuesta tendrá la siguiente estructura

No todos los errores están controlados y se manda como respuesta con estructura JSON. A la hora de procesar la respuesta hay que tener esto en cuenta

Ejemplos de invocación

A continuación se muestran ejemplos de invocación al método, en concreto se muestra el JSON que debe contener el body de la llamada POST.

2.- Anexos

2.1.- Objetos comunes

2.1.1.- ExtensionParameters

2.1.2.- SifeDocument

2.1.3.- VerificationReport

2.1.4.- SignatureStatus

2.1.5.- VerificationError

2.1.6.- CertificateStatus

2.1.7.- TimestampStatus

2.1.8.- TimestampToken

2.2.- Tipos enumerados

2.2.1.- SignatureLevel

2.2.2.- DigestAlgorithm

2.2.3.- Indication

2.2.4.- SignatureFormat

2.2.5.- Status

2.2.6.- TimestampType

2.1.- Errores generales al consumir la API