Optima Resources¶
Optima Gateway APIs¶
Resources to access and use Optima Gateway APIs:
- Swagger OpenAPI Docs:
| Environment | Swagger Open API URL Link |
|---|---|
| Dev | https://optima-dev.optumrx.com/gateway/swagger-ui/index.html |
| Stage | https://optima-stage.optumrx.com/gateway/swagger-ui/index.html |
| Prod | https://optima-prod.optumrx.com/gateway/swagger-ui/index.html |
- POSTMAN Collection for Optima Gateway - Link
Getting started with Optima Gateway APIs¶
The following document explain how to use Optima Gateway APIs:
- Fetch Access Token for Authorization
- Use Zeebe / Operate / Tasklist / Optimize APIs
Fetching Access/Bearer Token¶
All the Zeebe, Operate, Tasklist and Optimize APIs are authorized and cannot be consumed without an Authorization Bearer Token.
In order to perform any operation or consume any APIs, generate an access token and pass it in the header as Authorization: Bearer <token>.
For more details: Authorizing Optima Gateway APIs
Zeebe / Operate / Tasklist / Optimize APIs¶
Pass the above received access token as a Bearer Token to each API.
Also pass the tenant as a header with each API.
GET/POST/PUT/PATCH/DELETE https://{host-url}/{gateway-path}/{module}/{version}/{api}
Request Headers:
- Authorization: Bearer <--access-token-->
- tenant: <--tenant-name-->
References to Module wise API Specifications¶
- Zeebe API Specification - Link
- Operate API Specification - Link
- TaskList API Specification - Link
- Optimize API Specification - Link
Optima Admin Console APIs¶
Resources to access and use Admin Console APIs:
- Swagger OpenAPI Docs:
| Environment | Swagger Open API URL Link |
|---|---|
| Dev | https://optima-dev.optumrx.com/admin-console/swagger-ui/index.html |
- POSTMAN Collection for Optima Admin Console - Link