API
A public REST API to build on your data
Everything you see in the OptiPeople Data Platform is available programmatically. Pull OEE, machines, stops, shifts and telemetry into your own apps, dashboards and automations with a documented REST API: plain JSON over HTTPS, authenticated with an access key you create in the portal.
GET /v1/machines/42/oee
Authorization: Bearer •••••
{
"oee": 0.87,
"availability": 0.94,
"performance": 0.96
}
Your data, on your terms
Sometimes the value is in your own system: a BI model your controllers maintain, a shopfloor screen your operators watch, an internal app your IT team owns. The platform REST API gives developers direct, authenticated access to production data, so you can extend the platform however your business needs. The data flows both ways: export what OptiPeople Data Platform has collected, or send machine states, part counters and telemetry in from your own systems over MQTT with a documented JSON schema. No black-box lock-in: the data is yours, and the API proves it.
Developer-ready
Clean REST endpoints
Predictable, resource-based endpoints with JSON responses for machines, OEE, stops, telemetry and more. Test a connection directly in the browser: if the endpoint returns JSON, you're connected.
Documented with Swagger
An interactive OpenAPI reference lets you explore and try every endpoint before you write a line of code. What you see in the reference is what the API returns.
Secure, scoped access
Access keys are created and managed in the portal, and every request is authenticated over HTTPS. You decide exactly what each integration can read and do.
Efficiency data, ready to export
The main data export covers availability, performance, quality, units, shifts and stop causes, the numbers behind your OEE, structured for reporting and BI tools like Power BI.
Filter to what you need
Query parameters like machineId, from and to limit a response to one machine or one time window. Pull a single line's night shift instead of the whole plant's history.
Send data in over MQTT
The platform also accepts data: machine states, part counters and telemetry are ingested over MQTT using a documented JSON schema, with UTC timestamps and per-device IDs.
How teams use it
Reporting in Power BI
Controllers pull shift, OEE and stop-cause data into their own BI models on a schedule. The factory's numbers land in the same reports as the rest of the business.
Your own screens and apps
IT builds a shopfloor display or an internal app on live production data. The API serves the same numbers the platform shows, so the two never disagree.
Feeding data in
A line with its own control system publishes states and counters over MQTT. The data lands in the platform alongside everything else, in the same structure.
Start building on OptiPeople
Explore the live API reference, or talk to us about access keys and what your first integration could look like.