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.

 

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.

 

Estos servicios OData dependen del protocolo OAuth.

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

 

OAuth

El API de Bizagi implementa dos de los flujos especificados para OAuth versión 2.0, los que más comúnmente se utilizan:

 

1.Código de Autorización:

Permite a la aplicación cliente autenticar con las credenciales ingresadas en tiempo de ejecución (por medio de una página de inicio de sesión).

Esto quiere decir que el flujo fue diseñado para tener interacción humana, donde las peticiones usarán una suplantación de los usuarios finales.

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

 

2.Credenciales de Cliente:

Permite la integración de servidor a servidor donde no hay necesidad de usar credenciales por parte de los usuarios finales.

Para mayor información respecto a este tema, refiérase a https://tools.ietf.org/html/rfc6749#section-1.3.4.

 

Servicios de Datos y Metadata

Bizagi ofrece dos servicios de OData: uno que maneja nuestras propias definiciones (datos) y otro que maneja las definiciones almacenadas en el modelo de Bizagi (metadata).

 

Para mayor información sobre el primer servicio de OData, refiérase a Servicios de datos.

Para mayor información sobre el segundo servicio de OData, refiérase a Servicios de metadata.

 

Para iniciar y conocer el uso de los servicios de OData, refiérase a Guía de inicio.