Introduction
Developer Documentation¶
Welcome to the Bühler Developer documentation. This documentation is designed to help developers integrate their applications with the Bühler Digital Platform APIs — covering both the Bühler Insights Platform API and the Maintenance API.
Whether you’re building a custom application or integrating with an existing system, this documentation provides the information you need to get started. From API reference guides to sample code and tutorials – let’s explore the possibilities of the Bühler Digital Platform.
Overview¶
Choose the API that matches your integration use case either by going through the short description below or by visiting the more detailed distinction in the Bühler Developer APIs.
Bühler Insights Platform API¶
Enables customers to access and analyze machine telemetry data from Bühler systems via a structured API layer of the Digital Platform.
| Feature | Description |
|---|---|
| Telemetry queries | Query time-series data, events, and alarms using Kusto Query Language (KQL) |
| Data ingestion | Push Generic Data Model (GDM) messages into the platform from your own devices |
Maintenance API¶
Enables customers to exchange maintenance-related information with Bühler over API.
| Feature | Description |
|---|---|
| Jobs Done | Retrieve completed job records |
| Jobs Planned | Retrieve planned maintenance job records |
| Assets | List registered assets at a plant |
| Tasks | Retrieve and create maintenance tasks |
| Inventory | Submit inventory stock-level updates |
Environments & Base URLs¶
Bühler Insights Platform API¶
| Environment | Base URL |
|---|---|
| Test | https://test.api.buhlergroup.com/insights/v1 |
| Stage | https://stage.api.buhlergroup.com/insights/v1 |
| Demo | https://demo.api.buhlergroup.com/insights/v1 |
| PROD | https://api.buhlergroup.com/insights/v1 |
Each environment uses a distinct Azure Active Directory tenant and OAuth scope. Your clientId, clientSecret, and environment-specific scope are provided by Bühler Insights Support. See Authentication for the full per-environment AAD details.
Maintenance API¶
| Environment | Base URL |
|---|---|
| Test | https://test.api.buhlergroup.com/maintenance/v1 |
| Stage | https://stage.api.buhlergroup.com/maintenance/v1 |
| Demo | https://demo.api.buhlergroup.com/maintenance/v1 |
| PROD | https://api.buhlergroup.com/maintenance/v1 |
Access tokens are plant-scoped and issued by the Bühler COPC (Customer Operation Center). See Authentication for details.
Versioning & Lifecycle Policy¶
Both APIs adopt URI-based versioning. Each major version is distinguished by a unique root path.
Bühler Insights Platform API¶
- API v1.x.y:
https://api.buhlergroup.com/insights/v1
Maintenance API¶
- API v1.x.y:
https://api.buhlergroup.com/maintenance/v1
Each API version is accompanied by its respective OpenAPI specification which can be accessed in the API Reference page.
Semantic Versioning¶
Our APIs employ semantic versioning, which follows the Major.Minor.Patch format:
- Major: The major version increments only when there's a breaking change in the API. Introducing a new major version necessitates a new base URL.
- Minor: Any addition or modification that doesn't break the existing API will result in an increase in the minor version. While these changes are reflected in the OpenAPI specification, they don't alter the base URL. Typically, actions such as adding a new operation, adding an output property, or removing an input property trigger a minor version bump.
- Patch: Corrections, like bug fixes or other internal changes that don't affect the API's external behavior, will see an increase in the patch version.
Legacy Version Support¶
We pledge support for versions older than the most recent major release for a minimum of 6 months. However, for optimal performance and features, migrating to the latest major version at the earliest is advised.
Essential Resources¶
Bühler Insights Platform API¶
Complete documentation for the Bühler Insights Platform API, including:
- Getting Started – Initial setup and configuration
- Authentication – Security and access management
- Query / Ingestion API – Data querying and ingestion capabilities
- Limits – API usage limits and constraints
- Versioning – API version management
- API Reference – Complete endpoint documentation
Generic Data Model¶
The standardized data exchange format for sending data to Bühler. This model ensures consistent data structure across all integrations.
Explore the Generic Data Model
GDM Extensions¶
Extensions and additional capabilities for the Generic Data Model to support specialized use cases.
Maintenance API¶
Complete documentation for the Maintenance API, including:
- Getting Started – Initial setup and configuration
- Authentication – Security and access management
- Limits – API usage limits and constraints
- Errors – Error codes and handling
- API Reference – Complete endpoint documentation
Support¶
For technical questions and support regarding Bühler API integration, please refer to the documentation sections or contact your Bühler representative.
{"environments":[],"pdf-download":true}