Using Bizagi API in middlewares

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData RESTful services >

Using Bizagi API in middlewares


Bizagi has a RESTful API to integrate external systems using the OData standard. See the OData layer. This API exposes several methods that let an external system create instances of processes, tasks, obtain information about cases, and related to the experience design.


Although OData itself is a standard, systems expect the specification of APIs in a single language. RAML and OpenAPI languages that provide a format that both the API provider and consumer can use. Bizagi has created descriptors of some of the Bizagi OData services in both RAML and OpenAPI. With this, you can test and invoke OData methods directly from the  API manager.



RAML stands for RESTful API Modeling Language. Using this language, you can define a description of an API to help developers to manage an API lifecycle: Designing, building, testing, documenting, and using. As a modeling language, RAML let you translate an API technical description, into a language applications with a user interface can use, so developers can test, configure and document an entire API without using code.


To learn more about Bizagi's RAML descriptor, click here.



The OpenAPI Specification (OAS) is an API description format for RESTful APIs which allows both humans and computers to understand the capabilities of the service without access to source code. The specification can be written in easy learning and reading formats such as YAML or JSON.


To learn more about Bizagi's OpenAPI descriptor, click here.