Introducción
Bizagi tiene una API RESTful para integrar sistemas externos utilizando el estándar OData. Aunque OData en sí es un estándar, los sistemas esperan la especificación de las API en un solo idioma. RAML es uno de estos lenguajes. Éste proporciona un formato que tanto el proveedor de API como el consumidor pueden usar de manera estandarizada y mutua.
Usando RAML, hay proveedores de servicios que ayudan a las organizaciones a mantener centralizadas y organizadas todas sus APIs. Una oferta de administrador de API es Mulesoft. Vamos a utilizar Mulesoft para mostrar cómo se pueden usar los servicios de Bizagi OData con RAML.
Descriptor RAML de la capa OData
La capa de integración de Bizagi es OData. El descriptor RAML traduce la API OData en RAML, por lo que puede crear un activo en Anypoint y utilizar todos los puntos finales de integración dentro de Mulesoft.
Este descriptor contiene los siguientes métodos OData. Vea nuestro índice de servicios:
•Cases
•Cases(Id)
•Cases/Workitems
•Cases/Workitems(Id)
•Cases/Workitem(Id)/Next
•Processes
•Process(Id)
•Processes(Id)/Start
•Processes(Id)/Cases
|
Antes de usar el descript OData en RAML, le recomendamos entender la capa OData primero. Vea iniciando la capa OData. |
Descargue el descriptor RAML de Odata
Haga clic aquí para descargar el archivo ZIP que contiene el descriptor RAML de Bizagi Odata.
Estructura de Mulesfot
La integración entre diferentes sistemas es una preocupación común en las organizaciones. La forma habitual de exponer una capa de integración es a través de las API. Cada sistema y aplicación en las empresas principales puede variar su API, en función de las tecnologías, protocolos y sistemas utilizados. Administrar y centralizar la información relacionada con las API podría ser una tarea exigente que Mulesoft quiere abordar.
Dentro de la misma plataforma, puede cargar API de sistemas como Bizagi o Salesforce. Luego, crear su API para escenarios comerciales específicos en un área en particular, por ejemplo, el pago de Facturas en el área de Finanzas. Esta API empresarial puede contener un conjunto completo de API de sistemas necesarios para ejecutar una tarea de negocio. Por ejemplo, crear la factura de un cliente. Finalmente, puede crear una capa de experiencia de API dirigidas a dispositivos o tecnologías definidas, por ejemplo, una aplicación web o un dispositivo móvil. La siguiente imagen muestra cómo se pueden estructurar las API en Mulesoft.
Mulesoft tiene una plataforma web llamada Anypoint, donde puede administrar la integración de todos sus sistemas y aplicaciones, reutilizando sus API.
Cada API puede estar contenida en un único objeto llamado Activo (Asset). Para cada activo, puede definir la documentación, las políticas, los puntos finales y toda la información relacionada con la API.
Para la creación de activos, Anypoint tiene el módulo de Exchange para agregar o crear activos privados o públicos. Los activos públicos están expuestos en un repositorio público proporcionado por Mulesoft. Por otro lado, puede crear activos privados, donde puede definir el tipo de activo, dependiendo de cómo esté expuesta la API:
•REST RAML
•API SOAP usando WSDL
•API HTTP
•Personalizado
Después de crear o agregar un activo, y configurarlo, puede usar esta API relacionada con el activo en las aplicaciones que puede construir en Anypoint.
Configuración del activo (Asset)
Para configurar el activo, usted necesita ingresar a la plataforma the Anypoint.
Haga clic en el menú de tres líneas en la parte superior iquierda, y seleccione Exchange.
En el módulo privado, haga clic en Publicar nuevo activo, que está en la parte superior derecha.
Ingrese el nombre del activo, y seleccione el tipo REST API -RAML. Luego suba el archivo ZIP que contiene el descriptor de Bizagi OData RAML. Asegurese de que el archivo principal sea api.raml. Finalmente de clic en Publicar.
Cuando usted ingrese al activo, va a encontrar 3 áreas de diseño principales.
1. Especificación del activo: Esta sección contiene los siguientes elementos.
Elemento |
Descripción |
|---|---|
Endpoints |
Métoos de la capa de OData de Bizagi contenidos en el descriptor de RAML. |
Documentation |
Descripción del archivo RAML. |
Types |
Tipos de respuestas que puede encontrar en los endpoints. Cada objeto de respuesta muestra la estructura JSON. |
Security |
Tipos de autenticación disponibles en los métodos. |
API instances |
Esta sección contiene todas las URL desde donde se puede invocar la API (activo). Desde aquí, puede configurar la URL del proyecto Bizagi que está integrando a través del activo Mulesoft. |
2. La sección central es el área de diseño. Cuando hace clic en un módulo desde el panel izquierdo, el área de diseño, Anypoint muestra el área de diseño de ese objeto. Por ejemplo, cuando hace clic en un Endpoint, encuentra su descripción en el área de diseño.
Aquí encontrará la descripción de cada endopoint (método OData), incluidos ejemplos de entradas y salidas. Por ejemplo, en los métodos POST, puede encontrar la estructura de la entrada esperada.
3. Panel de detalles: en este panel, encontrará información detallada sobre el módulo seleccionado. También puede compartir el activo con otros usuarios de Mulsefot, descargar el descriptor RAML y agregar etiquetas.
Las pestañas que se muestran en este panel dependen del módulo seleccionado en la sección de especificación de activos.
Aprenda cómo configurar un activo con un proyecto de Bizagi.
Last Updated 2/26/2024 2:59:11 PM