Servicios OData

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas >

Servicios OData

Introducción

Bizagi provee acceso programático a la información subyacente de negocio en su modelo de datos, al tener una API poderosa basada en servicios OData y REST.

Esta API le permite trabajar con la información de sus procesos desde aplicaciones externas, especialmente para las características de Diseño de experiencia como iniciar nuevos procesos relevantes, ejecutar búsquedas y disparar acciones, o buscar casos pendientes en otros portales o las herramientas de su elección.

 

logo-OData

 

Conceptos Básicos de OData

Bizagi es compatible con OData versión 4.0, al tener un grupo de posibilidades exhaustivo para trabajar con lo subyacente de los procesos empresariales.

Los servicios OData son construidos como servicios REST (incluyendo recursos, accesibles a través de URLs mientras se hace que cada recurso haga uso de un identificador único).

 

Como los servicios REST, estos se basan en un grupo fijo de métodos HTTP, mostrados en la tabla a continuación:

 

MÉTODO HTTP

DESCRIPCIÓN

GET

Es una operación de sólo lectura.

Es usada para consultar información específica en el servidor.

Es una operación es idempotente (no importa cuantas veces se aplique la operación, el resultado será siempre el mismo) y segura (invocar un GET no cambia el estado del servidor).

POST

La operación POST es la única que no es idempotente ni segura en HTTP (esto quiere decir que puede modificar el servicio en una manera única).

Se puede enviar o no, información con la solicitud.

Se puede recibir o no, información con la respuesta.

 

Para mayor información sobre las especificaciones de OData, refiérase a http://www.odata.org/.

 

Seguridad en el API de Bizagi

Los servicios de OData en Bizagi están protegidos y cuentan con un mecanismo de autenticación estándar: OAuth version 2.0.

Las solicitudes presentadas a estos servicios necesitan ser concedidas con derechos a los recursos, utilizando las llaves OAuth previamente generadas.

Con la especificación de OAuth version 2.0, Bizagi soporta los dos flujos de OAuth, que son los más utilizados:

 

3.Código de autorización:

Esto permite a la aplicación del cliente autenticar a los usuarios con las credenciales introducidas en tiempo de ejecución (a través de una página de inicio de sesión).

Este flujo es diseñado para la interacción humana, dónde las solicitudes utilizan la suplantación de los usuarios finales.

Para más información sobre esta especificación, refiérase a https://tools.ietf.org/html/rfc6749#section-1.3.1.

 

4.Credenciales del Cliente:

Esto permite la integración de servidor a servidor sin el uso adicional de credenciales específicos de usuarios finales.

Para más información sobre esta especificación, consulte https://tools.ietf.org/html/rfc6749#section-1.3.4.

 

5.Bearer Token:

Esto permite a la aplicación del cliente autenticar utilizando un token.

Para más información sobre esta especificación, refiérase a https://tools.ietf.org/html/rfc6750.

 

Servicios del API de Bizagi

Bizagi ofrece dos servicios diferentes de OData services: uno para acceder a los datos de negocio (recursos clasificados como parte de los servicios de datos), y otro para acceder a la configuración de acuerdo con la definición de los Stakeholders (recursos clasificados como parte de los servicios de metadata).

A través de los servicios de datos, usted puede contar con lo siguiente en Bizagi:

 

Obtener información relacionada con los Stakeholders por ejemplo mis cosas o búsquedas, y ejecutar acciones de elementos de experiencia.

Crear un nuevo caso para procesos.

Entidades de consulta.

Obtener la lista de casos pendientes con sus actividades pendientes (independiente de si es un Stakeholder o no).

Completar una actividad pendiente o un evento enviando la información relacionada a dicha actividad o evento de un usuario final (independiente de si es un Stakeholder o no).

Buscar casos específicos y obtener sus detalles, a través del identificador del caso.

 

Para iniciar y probar por su cuenta el uso de los servicios de OData, consulte la Guía de inicio.

 

A través de los servicios de metadata, usted puede obtener detalles enfocados a cómo invocar servicios de datos adicionales, como: Obtener la lista de Stakeholders en el proyecto, procesos, procesos relevantes o colecciones de Mis cosas que estén bajo el Diseño de experiencia.

 

Para una lista completa de recursos de cada servicio, consulte el Índice de servicios.

Además, se recomienda que revise la información presentada bajo los Conceptos Básicos de este API.