Las API de acceso digital permiten que los sistemas de terceros se integren con el sistema de procesos de workflow de Evolve. Estas API están protegidas con la puerta de enlace de API y su mecanismo de autenticación compatible.
Requisitos previos
Los requisitos previos para poder utilizar la API de acceso digital son los siguientes:
-
Se debe activar la «licencia de acceso digital para el proceso» en el sistema Evolve.
-
El valor de la clave «ProcessExtensionEnable» debe establecerse en True.
El administrador puede desactivar esta función temporalmente desde Sistema de aplicaciones → Infraestructura → Configuración avanzada. Esta función se puede deshabilitar quitando la clave ProcessExtensionEnable y se puede reactivar añadiendo la categoría «System» y estableciendo la clave «ProcessExtensionEnable» en True.
Habilitar o deshabilitar la API para una solución de Composer
De forma predeterminada, todas las soluciones. Por ejemplo, las soluciones de Excel y las soluciones de formularios están habilitadas para poder acceder a ellas desde la API. Por lo tanto, tan pronto como se active una licencia, se podrá acceder a todas las soluciones existentes desde la API. Se puede excluir explícitamente una solución de la API, lo que restringirá el acceso a una solución específica desde la API; es decir, no se podrá iniciar un proceso ni completar una asignación para las soluciones excluidas. Para excluir una solución, selecciónela y cambie las propiedades de la API de esa solución desde la cuadrícula de soluciones. Solo el administrador de aplicaciones o el desarrollador de soluciones pueden ver el botón Propiedades de API y pueden cambiar el valor de esta propiedad.
Detalles de uso de la API para una solución de Composer
El usuario puede comprobar el uso de la API para una solución seleccionando la solución y haciendo clic en el botón Uso de API en las opciones. En el caso de las soluciones de formularios, el administrador de aplicaciones puede ver el uso para Query y para Transaction. En el caso de las soluciones de Excel, el administrador de aplicaciones solo puede ver el uso para Transaction.
Generación de carga útil
El usuario puede descargar la carga útil desde la cuadrícula de soluciones tanto para las soluciones de formularios como para las soluciones de Excel. Para descargar la carga útil para soluciones de formularios en formato JSON, haga clic en el botón Carga útil JSON y para descargar dicha carga en formato XML, haga clic en el botón Carga útil XML. En el caso de las soluciones de Excel, el usuario solo puede descargar la carga útil en formato JSON. Para descargar la carga útil, seleccione la solución en la cuadrícula de soluciones y haga clic en el botón Carga útil.
- Un formulario debe implementarse al menos una vez mientras se descarga la carga útil XML\JSON para una solución de formularios. La carga útil XML\JSON descargada corresponderá a la última versión del formulario implementado.
- La carga útil XML\JSON incluye cualquier valor predeterminado indicado en el formulario para los campos normales o de repetición.
- Utilice la API getDocument para descargar la carga útil XML\JSON actual para los procesos en ejecución: «<URLdelSitioDeEvolve>/svr/api/v1/Processextn/GetDocumentDataByProcess/Form/{Id-de-proceso}/XML» o «<URLdelSitioDeEvolve>/svr/api/v1/Processextn/GetDocumentDataByProcess/Form/{Id-de-proceso}/JSON»
- Dicha API devolverá la carga útil XML\JSON con valores predeterminados o facilitados para el proceso en ejecución.
- Al descargar la carga útil JSON, si el usuario es un administrador global o un administrador de aplicaciones, el parámetro AppName se agregará a la descarga de la carga útil JSON. Si el usuario no es administrador, tendrá que agregar el parámetro AppName manualmente después de descargar la carga útil.
Para la URL de Evolve, el usuario debe proporcionar el número de puerto, a menos que no sea el predeterminado. Por ejemplo, si tenemos un sitio de Evolve en el puerto 80 predeterminado, podemos utilizar las dos direcciones URL de Evolve para acceder a la API.
-
http://cha-de-vstpnx1.wsdt.local:80/svr/api/v1/Processextn/GetAllAssignments
-
http://cha-de-vstpnx1.wsdt.local/svr/api/v1/Processextn/GetAllAssignments.
Para las tres opciones de seguridad, hay que utilizar los siguientes prefijos de ruta para acceder a la API:
Secreto de cliente: «<URL de Evolve>/svr»
Token seguro: «<URL de Evolve>/svr»
Certificado: «<URL de Evolve>/svrc»
A continuación, se detallan las diferentes API de acceso digital:
| Nombre de API | Método HTTP | Distribuir | Descripción |
|---|---|---|---|
| CompleteAssignment | POST | <PrefijoDeRuta>/api/v1/Processextn/CompleteAssignment | Esta API permite completar una asignación pendiente existente. |
| GetAllAssignments | GET | <PrefijoDeRuta>/api/v1/Processextn/GetAllAssignments | Esta API devuelve todas las asignaciones pendientes con compatibilidad con filtros limitados de OData. Permite filtrar los datos para un usuario o una solución específica pasando el filtro de OData en la URL de la API. |
| GetDocumentDataByProcess | GET |
<PrefijoDeRuta>/api/v1/Processextn/GetDocumentDataByProcess/<tipo de documento>/<id de proceso>/<formato> tipo de documento: «Excel» o «formulario» formato: “json” o “xml”. Funciona solo para documentos de formulario. |
Esta API devuelve la última copia del documento del proceso para el id. del proceso especificado. |
| StartExcelProcess | POST |
|
Esta API inicia un proceso de workflow de Excel. El archivo Excel enviado se manda a la respectiva biblioteca de soluciones y también se inicia un proceso nuevo en este documento nuevo. |
| StartFormJsonProcess | POST | <PrefijoDeRuta>/api/v1/Processextn/StartFormJsonProcess | Esta API inicia un proceso de workflow de formularios. Los datos de formulario iniciales deben enviarse en formato JSON. Debe ser un JSON de formulario válido, ya que no se realiza ninguna validación de datos ni se ejecutan reglas de campo al guardar estos datos de formulario. |
| StartFormProcess | POST |
<PrefijoDeRuta>/api/v1/Processextn/StartFormProcess |
Esta API permite iniciar un proceso de workflow de formularios. Los datos de formulario iniciales deben enviarse en formato XML. Debe ser un XML de formulario válido, ya que no se realiza ninguna validación de datos ni se ejecutan reglas al guardar estos datos de formulario. |