Eximee API

Eximee API is the unified integration layer of the Eximee platform, which is divided into:

1. EximeeBPMS API – handling of processes, tasks and history in terms of BPMN 2.0.

2. Eximee API – access to case statuses, document generator, data model, configuration and event notifications.

EximeeBPMS API

Role and architecture

Interface for starting and supervising process instances, managing user and automated tasks, event communication and reviewing case history. Designed to work with EximeeBPMS and other engines implementing BPMN 2.0.

Functional scope

• Process instances • starting a process instance (with separation of business and process data), • retrieving instance details (including process and business variables).

• Process variables • changing the value of a process variable.

• User tasks (User Tasks) • retrieving process and business data, • changing state, • approval with submission of variables, • managing the assigned user.

• Automatic tasks (Service Tasks) • asynchronous handling of service tasks.

• Event communication • sending a message to the process.

• Incidents • retrieving information about an incident, • retrying the task where the incident occurred.

• Lists and history • task list, process list, case history.

Integrations

• Eximee Forms – forms as an interface to user tasks.

• Eximee Case Management – presentation of task/case lists and history.

• Eximee Data Model Runtime – reading/writing business data during the process.

• Eximee Dashboard – UI layer for operational users.

Security and compliance

• OAuth 2.0 / OIDC (JWT), domain roles, operation audit.

• TLS 1.2+; rate limiting and the principle of least privilege.

Example scenarios

• Starting a process from CRM and tracking the instance status.

• Approving a user task with passing variables.

• Retrying an incident of a service task.

Eximee API

Role and architecture

General platform interfaces not directly related to process execution: case status, document generator, data model, configuration and event notifications.

Functional scope (only methods from the document)

• Case status • creating a status, • updating a status, • retrieving a status.

• Document generator • ordering document generation based on provided data (with an option to use the data model).

• Application data model • access to structure of the model, • access to data (read).

• Application configuration • read-only access to configuration.

• Notifications about events from external domains • notifying the platform about events in external domains that support processes.

Integrations

• Eximee Document Generator – execution of document generation orders.

• Eximee Model Runtime – providing the application structure/data.

• Eximee Configuration Server – read-only configuration.

• External systems – reporting domain events.

Security and compliance

• OAuth 2.0 / OIDC (JWT), domain roles, access audit.

• TLS 1.2+; rate limiting; API versioning (e.g. /v1/...).

Example scenarios​

• CRM reads the structure and data from the model and the current case status.

• A scoring system reports an event that triggers further steps on the Eximee side.