Open API Specification

This document helps to understand how to use Open API Specifications and consume APIs for tenants to use Optima Gateway.

Step 1:- Visit the page

1. Open the Open API Spec page.

Environment	Open API site Link
Dev	TBD
Stg	Link
Prod	TBD

Step 2:- Fetch Auth Token

1. Click on 1. Auth Token section.
2. Click on Try it out button.
3. In the header, provide client.
4. In the Request Body, provide clientId in the value of "username" and clientSecret in the value of "password".
5. Click on Execute.

If the details provided are correct, you will get an accessToken in the response body

Step 3:- Authorize

1. Copy the accessToken retrieved from the Step 2.
2. Go to top, and click on Authorize button.
3. Paste the token in the input field.
4. Click on Authorize button.

Step 4:- Consume Zeebe / Operate / Tasklist / Optimize

Use this same step to consume any of the APIs of Zeebe / Operate / Tasklist / Optimize.

1. Click on the respective section.
   • 2. Zeebe for Zeebe APIs.
   • 3. Operate for Operate APIs.
   • 4. Tasklist for Tasklist APIs.
   • 5. Optimize for Optimize APIs.
2. Click on Try it out button.
3. In the header section, provide client.
4. In the Request body, provide necessary Request Body with values as per the API.
5. Click on Execute.

Contributors

1. Parth Shah