Usando OData con OpenAPI

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios RESTful OData > Usando el API de bizagi con middlewares >

Usando OData con OpenAPI

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. OpenAPI es uno de estos lenguajes. Este descriptor open-source proporciona un formato que tanto el proveedor de API como el consumidor pueden usar de manera estandarizada y mutua.

 

Descriptor OpenAPI de la capa OData

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

 

note_pin

Antes de usar el descriptor OData en OpenAPI, le recomendamos entender la capa OData primero. Vea iniciando la capa OData.

 

Descargue el descriptor OpenAPI de Odata

Haga clic aquí para descargar el archivo ZIP que contiene el descriptor OpenAPI de Bizagi Odata.

 

Usando la capa OData de Bizagi con OpenAPI

Para mostrar cómo utilizar la capa ODatat de Bizagi con OpenAPI, utilizaremos Postman como ejemplo. Sin embargo, puede usar cualquier middleware que soporte OpenAPI.

 

1.Importe el descriptor que acaba de descargar a Postman.

 

OpenAPI_01

 

2.Una vez ha importado el descriptor, puede ver todos los métodos disponibles en la columna de la izquierda en la pestaña de Colecciones.

 

OpenAPI_02

 

3.Seleccione el método que desea invocar. Vaya a la pestaña de Autorización y haga clic en Obtener Nuevo Token de Acceso.

 

OpenAPI_03

 

4.Complete la información solicitada para generar un nuevo ttoken. Este token será utilizado para todas las invocaciones de métodos que haga.

 

OpenAPI_04

 

Los parámetros se deben llenar de la siguiente manera:

Nombre del Token: nombre que quiera dar a su token.

Tipo de permiso: Client Credentials

Access Token URL: URL del servicio para su proyecto Bizagi. Asegúrese que la URL corresponde a la URL donde los usuarios finales acceden al Portal de trabajo de Bizagi.

Por ejemplo, para proyectos de Bizagi en sus instalaciones, esta URL sería:

https://[su_servidor]/[su_proyecto]/oauth2/server/token

Mientras que para proyectos de Automation Service, esta URL sería:

https://[ambiente_del_proyecto]-[su_proyecto]-[su_compañia].bizagi.com/oauth2/server/token

Client ID & Client Secret: llaves de acceso para su aplicación. Para aprender cómo obtener el Client ID y el Client Secret, vaya a iniciando la capa OData.

Scope: api

Autenticación de cliente: Enviar como encabezado Basic Auth.

 

5.Haga clic en Send para invocar el método y espere por su respuesta.

 

OpenAPI_05

 

En este ejemplo, usted puede ver que el caso18451 aparece como pendiente. Al ir al portal de trabajo, el mismo caso se puede ver en la bandeja de entrada.

 

OpenAPI_06