Eximee API

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

1. EximeeBPMS API – handling 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 automatic tasks, event communication and reviewing case history. Designed to work with EximeeBPMS and other engines implementing BPMN 2.0.

Functional scope

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

• Process variables • change of a process variable value.

• User tasks (User Tasks) • retrieval of process and business data, • change of state, • approval with submission of variables, • management of the assigned user.

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

• Event communication • sending a message to the process.

• Incidents • retrieval of incident information, • 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 – read/write of 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

• Start a process from CRM and track the instance status.

• Approve a user task with passing variables.

• Retry a service task incident.

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 (methods from the document only)

• Case status • create status, • update status, • retrieve status.

• Document generator • request generation of documents based on provided data (with an option to use the data model).

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

• Application configuration • read-only access to configuration.

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

Integrations

• Eximee Document Generator – execution of document generation requests.

• 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.

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