| Table of Contents |
|---|
...
cancelOperation: cancelación de operaciones realizadas a través de SCDE.
createCertificate: creación de documentos certificados firmados con sello de órgano (obsoleto, se recomienda el uso de createCertificate1).
createCertificate1: creación de documentos certificados firmados con sello de órgano (evolución del createCertificate).
getStatus: control del proceso de creación de los documentos.
sendDocAuth: envío de un documento de autorización firmado (obsoleto, se recomienda el uso de sendDocAuth1).
sendDocAuth1: envío de un documento de autorización firmado (evolución del sendDocAuth).
sendDocAuthByCSV (obsoleto)
getDocByCSV
signDocs: firma de documentos creados por otras aplicaciones (obsoleto, se recomienda el uso de signDocs1).
signDocs1: firma de documentos creados por otras aplicaciones (evolución del signDocs)
getDcmi: consulta los datos de los campos de un documento PDF.
cancelOperation: cancela una operación.
signDocsWithoutDocAuth: firma de documentos con sello de órgano sin documento de autorización.
signDocsWithExternalDocAuth: firma de documentos con sello de órgano a partir del CSV del documento de autorización.
La dirección para poder acceder al servicio es: http://scde_core/services/certificate_service
...
ServiciosPrivados
En el servicio público ICertificateService existen también dos servicios privados que son llamados desde la propia aplicación, en su módulo ADMIN:
listCertificateOperations ¿PÚBLICO?
downloadCertificateDocument
Servicios CertificateService
Antes de empezar a describir cada servicio, cabe destacar una serie de elementos comunes a los mismos.
...
Nombre | Tipo | Descripción |
|---|---|---|
Code | Long | Código que describe el tipo de error |
Msg | String | Mensaje asociado al tipo de error indicado en el código |
ExtraInfo | String | Posible información extra que se haya considerado oportuno indicar para localizar la causa del error |
Añadir códigos de error
Método ‘createCertificate’ (obsoleto)
...
Signatura ResultGetStatus getStatus(ParamGetStatus paramGetStatus) throws ScdeCoreException; Parámetros de invocación El parámetro de entrada al servicio es de tipo ParamGetStatus que extiende ParamBase. Su único atributo es un String con el código de la operación a consultar. Parámetros de respuesta Los datos de salida del servicio se encapsulan en el objeto ResultGetStatus Códigos error Las excepciones del servicio son de tipo ScdeCoreException. Ejemplos de invocación
Los posibles valores de STATUS_CODE devueltos por la aplicación serán: ERROR_GENERAL CREATING_DOCS, ERROR_CREATING_DOCS, WAITING_DOC_AUT SIGNING_DOCS, ERROR_DOC_AUT ERROR_SIGN_DOCS, END_OPERATION, ERROR_ID_OPERATION, OPERATION_TIMEOUT, CANCELING_OPERATION, OPERATION_CANCELED |
Método ‘sendDocAuth’ (obsoleto)
Se recomienda la integración con el método sendDocAuth1. Método del servicio que permite enviar la firma del documento de autorización existente, perteneciente a una operación generada en el servicio createCertificate. Devuelve el estado de la operación o una excepción si ha fallado.
Signatura ResultGetStatus sendDocAuth(ParamSendDocAuth paramSendDocAuth) throws ScdeCoreException; Parámetros de invocación El parámetro de entrada al servicio es de tipo ParamSendDocAuth que extiende ParamBase y contiene los siguientes atributos: Parámetros de respuesta Los datos de salida del servicio se encapsulan en el objeto ResultGetStatus Códigos error Las excepciones del servicio son de tipo ScdeCoreException. Ejemplos de invocación Para este ejemplo es necesario haber recuperado de Documentum, por medio del CSV, el documento de autorización. Una vez recuperado hay que firmarlo y elevar la firma a CAdES-A. Encapsulamos el identificador de operación en la que se ha generado el documento de autorización, la firma del documento ya elevada a CAdES-A y el identificador de la aplicación en un objeto ParamSendDocAuth e invocamos el servicio:
Si no se produce una excepción, el valor de STATUS_CODE será SIGNING_DOCS |
Método ‘sendDocAuth1’
Ofrece la misma funcionalidad que el sendDocAuth, no sólo para una operación generada en el servicio createCertificate sino también en el createCertificate1. También permite que el documento de resumen de la operación se firme con el sello de órgano informado (en lugar del que tiene configurado SCDE por defecto). Se recomienda su uso en lugar del sendDocAuth.
Signatura ResultGetStatus sendDocAuth1(ParamSendDocAuth1 paramSendDocAuth1) throws ScdeCoreException; Parámetros de invocación El parámetro de entrada al servicio es de tipo ParamSendDocAuth1 que extiende ParamBase y contiene los siguientes atributos: Parámetros de respuesta Los datos de salida del servicio se encapsulan en el objeto ResultGetStatus Códigos error Las excepciones del servicio son de tipo ScdeCoreException. Ejemplos de invocación Para este ejemplo es necesario haber recuperado de Documentum, por medio del CSV, el documento de autorización. Una vez recuperado hay que firmarlo y elevar la firma a CAdES-A. Encapsulamos el identificador de operación en la que se ha generado el documento de autorización, la firma del documento ya elevada a CAdES-A y el identificador de la aplicación en un objeto ParamSendDocAuth e invocamos el servicio:
Si no se produce una excepción, el valor de STATUS_CODE será SIGNING_DOCS |
Método ‘signDocs’ (obsoleto)
Se recomienda la integración con el método signDocs1. Método del servicio que permite firmar documentos generados por una aplicación externa. Para ello se enviará el CSV de un documento de autorización, es decir, un documento firmado y almacenado en el gestor documental del Gobierno de Aragón que tiene una relación de padre respecto a los documentos a firmar. El rol de dicha relación es REQUIERE. Es necesario introducir los parámetros que configuran el sello de órgano con el que poder firmar los documentos, así como los datos del titular de dicho sello. Junto al CSV se puede introducir también un texto que se estampará en la página y coordenadas del documento proporcionadas. Devuelve el estado de la operación o una excepción si ha fallado. Al finalizar el proceso de firma de documentos se informará mediante el servicio SGA a la dirección asociada en SIU al NIF del firmante del documento cuyo CSV se ha enviado.
Signatura ResultGetStatus signDocs(ParamSignDocs paramSignDocs) throws ScdeCoreException: Parámetros de invocación El parámetro de entrada al servicio es de tipo ParamSignDocs, que extiende ParamBase. Contiene los siguientes atributos:
Los datos de estampación de cada documento se pasan como una lista de objetos StampInfo. Si un CSV no se encuentra en esta lista se firmará sin estampar ningún texto. La clase StampInfo tiene los siguientes atributos: Nombre Tipo Descripción csv String CSV del documento. textToStamp String Texto a estampar. page int Página donde se realizará la estampación. coorInitX float Coordenada x inicial. coorInitY float Coordenada y inicial. coorEndX float Coordenada x final. coorEndY float Coordenada y final. Así mismo es necesario aportar los datos del titular del sello de órgano en un objeto User: Nombre Tipo Descripción name String Nombre del titular. surname1 String Primer apellido del titular. surname2 String Segundo apellido del titular. nif String No utilizado en este servicio. organism String No utilizado en este servicio. organismCode String Organismo del titular. position String No utilizado en este servicio. Parámetros de respuesta Los datos de salida del servicio se encapsulan en el objeto ResultGetStatus Códigos error Las excepciones del servicio son de tipo ScdeCoreException. Ejemplos de invocación Este servicio necesita encapsular dentro del ParamSignDocs que extiende del ParamBase, los parámetros con el CSV del documento que autoriza, el texto y posición a incluir, y los parámetros del sello de órgano con el que se van a firmar los documentos relacionados con el CSV. Configuramos los parámetros necesitados e invocamos el servicio:
Si no se produce una excepción, el valor de STATUS_CODE será SIGNING_DOCS |
Método ‘signDocs1’
Ofrece la misma funcionalidad que el signDocs. También permite que el documento de resumen de la operación se firme con el sello de órgano informado (en lugar del que tiene configurado SCDE por defecto). Se recomienda su uso en lugar del signDocs.
Signatura ResultGetStatus signDocs1(ParamSignDocs1 paramSignDocs1) throws ScdeCoreException: Parámetros de invocación El parámetro de entrada al servicio es de tipo ParamSignDocs1, que extiende ParamBase. Contiene los siguientes atributos:
Los datos de estampación de cada documento se pasan como una lista de objetos StampInfo. Si un CSV no se encuentra en esta lista se firmará sin estampar ningún texto. La clase StampInfo tiene los siguientes atributos: Nombre Tipo Descripción csv String CSV del documento. textToStamp String Texto a estampar. page int Página donde se realizará la estampación. coorInitX float Coordenada x inicial. coorInitY float Coordenada y inicial. coorEndX float Coordenada x final. coorEndY float Coordenada y final. Así mismo es necesario aportar los datos del titular del sello de órgano en un objeto User: Nombre Tipo Descripción name String Nombre del titular. surname1 String Primer apellido del titular. surname2 String Segundo apellido del titular. nif String No utilizado en este servicio. organism String No utilizado en este servicio. organismCode String Organismo del titular. position String No utilizado en este servicio. Parámetros de respuesta Los datos de salida del servicio se encapsulan en el objeto ResultGetStatus Códigos error Las excepciones del servicio son de tipo ScdeCoreException. Ejemplos de invocación Este servicio necesita encapsular dentro del ParamSignDocs1 que extiende del ParamBase, los parámetros con el CSV del documento que autoriza, el texto y posición a incluir, y los parámetros del sello de órgano con el que se van a firmar los documentos relacionados con el CSV. Configuramos los parámetros necesitados e invocamos el servicio:
Si no se produce una excepción, el valor de STATUS_CODE será SIGNING_DOCS |
Método ‘getDcmi’
Método del servicio que permite consultar los datos introducidos en los campos de un documento pdf y que figuran en sus metadatos como DatosDocumentoAdministrativo. Devuelve un objeto de tipo HashMap (campo, valor) con los datos extraídos, o una excepción si ha fallado.
Signatura ResultGetMetadata getMetadata(ParamGetDcmi paramGetDcmi) throws ScdeCoreException; Parámetros de invocación El parámetro de entrada al servicio es de tipo ParamGetDcmi, que extiende de ParamBase. Su único atributo es un DataHandler con el contenido del pdf a consultar. Parámetros de respuesta Los datos de salida del servicio se encapsulan en el objeto ResultGetMetadata, que contiene el siguiente atributo: Códigos error Las excepciones del servicio son de tipo ScdeCoreException. Ejemplos de invocación Invocamos el servicio con el DataHandler del fichero a consultar, el identificador de la aplicación origen y el NIF del usuario que invoca el servicio:
|
Método ‘cancelOperation’
Método del servicio que cancela una operación y anula los documentos asociados.
...
Signatura ResultGetStatus cancelOperation(ParamCancelOperation paramCancelOperation) throws ScdeCoreException; Parámetros de invocación El parámetro de entrada al servicio es de tipo ParamCancelOperation, que extiende de ParamBase. - En la primera llamada al servicio, el campo docCancelSign debe ser nulo; en la segunda deberá ir poblado con la firma del documento de cancelación. La propiedad user identifica al usuario que solicita la operación y cuyos datos serán reflejados en la banda de firma que aparecerá en el documento de cancelación. Parámetros de respuesta Los datos de salida del servicio se encapsulan en un objeto ResultGetStatus Códigos error Las excepciones del servicio son de tipo ScdeCoreException. Ejemplos de invocación Invocamos el servicio con el ParamCancelOperation con el identificador de Operación a cancelar aplicación origen, el NIF del usuario que invoca el servicio y el user que realizará la firma.
|
Método ‘signDocsWithExternalDocAuth’
Método del servicio que permite firmar documentos generados por una aplicación externa. Para ello se enviará el CSV de los documentos a firmar y el CSV de un documento de autorización, es decir, un documento firmado y almacenado en el gestor documental del Gobierno de Aragón. La diferencia con respecto al signDocs y signDocs1 es que será SCDE quien creará la relación de padre respecto a los documentos a firmar. El rol de dicha relación es REQUIERE.
...
Signatura ResultGetStatus signDocsWithExternalDocAuth(ParamSignDocsWithExternalDocAuth paramSignWithExternalDocAuth) throws ScdeCoreException; Parámetros de invocación El parámetro de entrada al servicio es de tipo ParamSignDocsWithExternalDocAuth, que extiende ParamBase. Contiene los siguientes atributos: - - - Parámetros de respuesta Los datos de salida del servicio se encapsulan en un objeto ResultGetStatus Códigos error Las excepciones del servicio son de tipo ScdeCoreException. Ejemplos de invocación Este servicio necesita encapsular dentro del ParamSignDocsWithExternalDocAuth que extiende del ParamBase, los parámetros con el CSV del documento que autoriza, el texto y posición a incluir, y los parámetros del sello de órgano con el que se van a firmar los documentos relacionados con el CSV.
Si no se produce una excepción, el valor de STATUS_CODE será SIGNING_DOCS. |
Método ‘signDocsWithoutDocAuth’
Método del servicio que permite firmar documentos generados por una aplicación externa. Para ello se enviará el CSV de los documentos a firmar. La diferencia con respecto al signDocs, signDocs1 y signDocsWithExternalDocAuth es que no se requiere un documento de autorización para realizar la firma de los documentos.
...
Signatura ResultGetStatus signDocsWithoutDocAuth(ParamSignDocsWithExternalDocAuth paramSignWithExternalDocAuth) throws ScdeCoreException; Parámetros de invocación El parámetro de entrada al servicio es de tipo ParamSignDocsWithoutDocAuth, que extiende ParamBase. Contiene los siguientes atributos: - - - Parámetros de respuesta Los datos de salida del servicio se encapsulan en un objeto ResultGetStatus Códigos error Las excepciones del servicio son de tipo ScdeCoreException. Ejemplos de invocación Este servicio necesita encapsular dentro del ParamSignDocsWithoutDocAuth que extiende del ParamBase, el texto y posición a incluir, y los parámetros del sello de órgano con el que se van a firmar los documentos relacionados con el CSV.
Si no se produce una excepción, el valor de STATUS_CODE será SIGNING_DOCS. |
Método ‘getDocByCSV’
Método del servicio que recupera los campos editables de un PDF alojado en Documentum a través de su CSV. Devuelve un objeto de tipo HashMap (campo, valor) con los datos extraídos, o una excepción si ha fallado.
Signatura ResultGetDocByCSV getDocByCSV(ParamGetDocByCSV paramGetDocByCSV) throws ScdeCoreException; Parámetros de invocación El parámetro de entrada al servicio es de tipo ParamGetDocByCSV, que extiende de ParamBase. Su único atributo es un csv del documento a consultar Parámetros de respuesta Los datos de salida del servicio se encapsulan en el objeto ResultGetDocByCSV, el cual contiene un objeto Map que contiene el campo con los valores del PDF. Códigos error Las excepciones del servicio son de tipo ScdeCoreException. Ejemplos de invocación
|
Método ‘sendDocAuthByCSV’ (obsoleto)
Envía el CSV de un documento de autorización que se debe encontrar ya firmado en CCSV, y el ID de operación correspondiente a ese documento de autorización. Continua la operación empezada con createCertificate1, firmando los documentos y terminando la operación.
...