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 BPMN 2.0 terms.

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

EximeeBPMS API

Role and architecture

Interface for launching and monitoring 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 a process instance (with separation of business and process data), • retrieve instance details (including process and business variables).

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

• User Tasks • retrieve process and business data, • change state, • approve together with sending variables, • manage the assigned user.

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

• Event communication • send a message to the process.

• Incidents • retrieve incident information, • retry the task where the incident occurred.

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

Integrations

• Eximee Forms – forms as the interface for user tasks.

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

• Eximee Data Model Runtime – read/write 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 variable transfer.

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

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

• Document generator • request document generation based on provided data (with the 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 • notify the platform about events in external process-supporting domains.

Integrations

• Eximee Document Generator – execution of document generation requests.

• Eximee Model Runtime – exposing 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.