Liberación

Manual de Usuario

[En esta plantilla se coloca el manual de usuarios de la aplicación de software.]

El servicio web Murachí es un programa que sirve para construir otras programas con soporte para firma electrónica y verificación. Por la naturaleza de este proyecto, no se tiene un manual de usuario final; en lugar de ello se cuenta con una documentación de la Interfaz de Programación de Aplicaciones (API) REST del servicio. En la documentación del API se detalla cada uno de los recursos disponibles del servicio en varias categorías:

• Información general: recursos para obtener información general del servicio como versión y estadísticas básicas.

• Gestión de archivos: recursos para cargar y descargar archivos al y desde el servicio, así como para verificar electrónicamente un archivo firmado.

• Gestión de firma electrónica en formato BDOC: recursos para aplicar firma electrónica y obtener información sobre documentos firmados electrónicamente en formato BDOC.

• Gestión de firma electrónica en formato PDF: recursos para aplicar firma electrónica y obtener información sobre documentos firmados electrónicamente en formato PDF.

La documentación del API de Murachí está disponible en el siguiente enlace: ​https://murachi.cenditel.gob.ve/apidoc/index.html.

Configuración para archivos descargables

[En esta sección se coloca la información concerniente a los archivos empaquetados de las diferentes versiones y sistemas operativos.]

El servicio web Murachí está construido siguiendo el estilo arquitectónico ​REST con la tecnología Java y el marco de trabajo ​Jersey que brinda soporte para el API JAX-RS y sirve como una implementación de referencia de JAX-RS. Jersey proporciona una biblioteca para implementar servicios web RESTful en un contenedor Servlet de Java.

Para el despliegue del servicio web Murachi se utiliza ​Apache Tomcat como contenedor de servlet, específicamente la versión 7.

El archivo descargable del servicio web Murachí se encuentra disponible en: https://tibisay.cenditel.gob.ve/murachi/downloads

Para desplegar el servicio web Murachi en Tomcat 7 se debe colocar el archivo Murachi.war en el directorio de aplicaciones web webapps de Tomcat. En el caso de utilizar el sistema operativo Debian GNU/Linux 7.9 el archivo desplegable de Murachi se debe colocar en el directorio /var/lib/tomcat7/webapps.

cenditel09-000a:/var/lib/tomcat7/webapps# ls -l
total 26184
drwxr-xr-x 4 tomcat7 tomcat7       35 sep 30 16:22 Murachi
-rw-r--r-- 1 root    root    25802952 sep 30 16:22 Murachi.war
drwxr-xr-x 8 tomcat7 tomcat7     4096 sep 18 13:40 pruebaservicioweb
-rw-r--r-- 1 tomcat7 tomcat7   996302 sep  9 10:46 pruebaservicioweb.war
drwxr-xr-x 7 tomcat7 tomcat7     4096 sep 22 14:31 ROOT

Una vez que el archivo Murachi.war se encuentra en el directorio webapps se inicia el Tomcat:

#cenditel09-000a:/var/lib/tomcat7/webapps# /etc/init.d/tomcat7 start

De esta manera el servicio web Murachí estaría desplegado en el servidor.

Flujograma de actividades