Skip to content

Overview

Optima Gateway

  • Optima Gateway is a centralized application using which tenant application could communicate with various Camunda modules such as Zeebe, Operate, Tasklist and Zeebe, in order to run and manage the workflows.
  • Gateway contains a bunch of REST APIs (module-wise), which communicates with the Camunda modules for necessary executions or getting back the necessary information related to workflows.
  • All the Gateway REST APIs are authorized with Bearer Token, which can be generated using client credentials (client id and client secret).
  • All the Gateway REST APIs are secured and authorized with RxAuthPass, which is also one of the Rx Platform offering for Authorization purposes.
  • Each team can have multiple clients created, and each client might have permissions to consume a set of APIs. For example: client-1 client can only have permissions to consume all the Zeebe APIs and not other APIs. client-2 client can only have permissions to consume few Zeebe APIs, few Operate APIs and not other APIs. And likewise.
  • These API level authorization (granting and revoking of APIs), can be achieved using the Optima Console UI, by the Tenant or Team Administrator.

Gateway Modules

Zeebe

Zeebe API is a REST API and provides functionalities related to workflow such as deploying the model, creating or cancelling process instance and more.

Operate

Operate API is a REST API and provides searching, getting, and changing Operate data. Requests and responses are in JSON notation.

Tasklist

Tasklist API is a REST API and provides searching, getting, and changing Tasklist data. Requests and responses are in JSON notation.

Optimize

Optimize API is a REST API and provides searching, getting, and changing Optimize data. Requests and responses are in JSON notation.