Developer documentation
The Celonis Developer Portal contains additional resources for developers such as API reference docs, schemas, requirements, tutorials and FAQs.
Standard Data Ingestion API
The Standard Data Ingestion API allows you to push real-time data to the Celonis Platform using your existing IT systems. This AWS S3 compatible API operates on events/notifications that get triggered whenever a new file reaches the API and automatically picks it up and processes it to a data pool.
Before using the Standard Data Ingestion API, use the links below to review your options for:
Deciding when to use the Standard Data Ingestion API versus using a Celonis extractor.
Comparing the benefits of using the Standard Data ingestion API to the potential implications.
Watching a demo video showing how to push data to the Celonis Platform using the Standard Data ingestion API.
Data Push API
Note
It is recommended that you use the Data Ingestion API to push your data into the Celonis Platform.
The Data Push API provides an easy way to create, execute, and monitor the micro-batch jobs used to transfer data into the Celonis Platform. Once the data is available in the Celonis Platform, you can transform, analyze and work with it as you would with a Celonis-provided extractor. Use the links below to access the Developer Portal in order to:
Download the open API specifications for the Data Push API.
Check out what you need to know before you begin using the Data Push API.
Test the various Data Push schemas used in the Celonis Platform.
See an example of the Data Push API written in Python.
Intelligence API
The Intelligence API allows customers to embed actionable intelligence into third-party platforms where end users may benefit from Celonis Intelligence insights. Use the links below to access the Developer Portal in order to:
Download the open API specifications for the Celonis Intelligence API.
View and test schemas for Knowledge Models and data defined in the Celonis Platform.
Review the prerequisites for using the Intelligence APIs and how to authenticate your requests.
Check the Error Catalog for common errors that may be returned by the system and the reason for each error.
Other Celonis APIs
Learn to use the Audit Log, Team Login History and Platform Adoption APIs with your applications and create extractors to pull detailed information from your team into Studio.
Use the Data Job Execution API to execute a data job and query the status of existing data jobs using an OAuth client.
Perform a complete or partial reload of your data models to ensure that the latest data from your source system is available by utilizing the Process Data Model API.
Manage user identities across various cloud-based applications, such as your source identity system and your Celonis Platform team, using the System for Cross-domain Identity Management (SCIM) protocol.
Push data to the Celonis Platform in real-time with the Standard Data Ingestion API. This AWS S3 compatible API operates on events and notifications that are triggered when a new file reaches the API and then automatically picks that file up and processes it to a data pool.
Celonis Process Management Admin Guides
The Celonis Process Management (formerly Symbio) documentation provides technical resources a variety of specialized user types:
The Celonis Process Management Admin documentation describes which tasks and activities can be only executed by users with an “Administrator” role in Celonis Process Management.
Review the endpoints, tasks, events, and gateways used by developers for the graphic service in the Celonis Process Management Developer Documentation.
Find specialized documentation for power users such as data warehouse service analysts in the Celonis Process Management Power Users section.