API & Integrations
ProAlert's single database is more valuable when it can share. The REST (Representational State Transfer) API exposes 60+ endpoints covering every module in the platform: authentication, assets, production, calls, video, CMMS (Computerized Maintenance Management System), workforce, and device management. If your ERP (Enterprise Resource Planning), MES (Manufacturing Execution System), or BI (Business Intelligence) platform can consume REST, it can consume ProAlert data in real time... without middleware, without a custom connector project, and without a vendor professional services engagement.
The bottom line: The value of having OEE, maintenance, production, and workforce data in one database compounds when that database can feed other systems. ProAlert's REST API lets your ERP see work order costs, your BI tool see live OEE trends, your time-and-attendance system see crew check-in data, and your physical Andon hardware initiate calls... all over standard HTTPS (HyperText Transfer Protocol Secure) with JWT (JSON Web Token) authentication.
The Data That Lives in a Silo Doesn't Help Anyone
-
Your ERP doesn't see maintenance costs in time to act on them.Maintenance labor and parts costs from work orders need to flow to the ERP for accurate asset cost accounting and production cost modeling. Without an API, that data gets exported manually once a month... after the period it would have changed decisions has already closed.
-
Your BI tool can't see live OEE without a real-time data feed.Power BI, Tableau, and similar tools can build excellent dashboards... if they have a live data source. A scheduled database export every hour produces dashboards that are always 59 minutes stale. The API's timeline status endpoints provide real-time asset state that BI tools can query on any interval.
-
Physical Andon hardware can't initiate calls without an API endpoint.Industrial Andon button panels, physical call stations, and PLC-triggered call initiation all need an HTTP endpoint to POST a DT (Downtime) call to. Without an API, physical hardware integration requires a custom middleware layer. With the ProAlert Call Log API, any hardware that can make an HTTP POST can initiate a call in under one second.
Authentication, Assets, and Production
| Endpoint Group | Key Endpoints | Primary Integration Use |
|---|---|---|
| Authentication | POST /account/login, POST /account/refresh-token, POST /account/logout | JWT token-based authentication with refresh. Third-party systems authenticate once and maintain a token. Tokens expire on configurable intervals... refresh endpoint extends sessions without re-login. |
| Assets | GET /assets, GET /assets/{id}, GET /assets/{id}/status, PUT /assets/{id} | ERP and MES systems query asset records and live status. BI tools query current status for dashboard feeds. Full CRUD (Create, Read, Update, Delete) for asset record management from external plant management systems. |
| Production | POST /production/run-start, POST /production/run-stop, POST /production/cycles, GET /production/oee-snapshot | External cycle counters and MES systems submit cycle data directly via API. OEE snapshot endpoint returns current Availability, Performance, and Quality for any asset for BI dashboard consumption. |
| DieRun (Die Run Management) | POST /dieruns, PUT /dieruns/{id}/finalize, POST /dieruns/{id}/scrap | Die scheduling systems and external quality tools submit cavity scrap data and trigger die run finalization. Enables integration of dedicated die tracking systems with ProAlert's cavity-level OEE calculations. |
Calls, Video, and CMMS
| Endpoint Group | Key Endpoints | Primary Integration Use |
|---|---|---|
| Call Log | POST /calls (initiate), POST /calls/{id}/claim, POST /calls/{id}/respond, POST /calls/{id}/close | Physical Andon buttons, PLC triggers, and industrial call stations initiate DT calls via POST. EdgeSense devices use these endpoints for GPIO-triggered call initiation. The full five-step lifecycle is exposed for any hardware or system that needs to interact with the call workflow. |
| Video | GET /video/stream/{cameraId}, GET /video/frames/{cameraId}, GET /video/clips/{callId} | External display systems retrieve live RTSP stream data. Quality management systems retrieve event-triggered clips by call ID for external storage or review. Frame-level access for custom analysis tools. |
| Work Orders | GET /workorders, POST /workorders, PUT /workorders/{id}/status, POST /workorders/{id}/labor, POST /workorders/{id}/parts | ERP systems create work orders from external purchase triggers. Labor entry APIs allow time-and-attendance systems to log actual hours against work orders. Parts usage APIs allow inventory systems to record consumption against work orders without requiring ProAlert mobile access. |
| Failure Modes | GET /failuremodes, POST /failuremodes, GET /rootcauses | Quality management systems populate failure mode and root cause libraries from external data sources. External RCA (Root Cause Analysis) systems read failure records from ProAlert for cross-system analysis. |
| Standard Work Templates | GET /templates/{assetType}, GET /templates/{id}/tasks, POST /templates/{id}/apply/{workorderId} | External scheduling systems apply standard work templates to work orders programmatically. Maintenance planning tools retrieve task lists from approved templates for external display or assignment. |
Devices, Timeline, and Workforce
| Endpoint Group | Key Endpoints | Primary Integration Use |
|---|---|---|
| Timeline Status | GET /timeline/{assetId}/current, GET /timeline/{assetId}/history, GET /timeline/all-assets/current | BI tools query real-time asset timeline status for live OEE dashboards. Facility management systems query all-asset current status for plant-level display. All-assets endpoint returns current priority-resolved status for every configured asset in a single call. |
| Shift Schedule | GET /shifts, GET /shifts/{assetId}/current, POST /shifts/{assetId}/schedule | Workforce management and HR systems read shift schedule data to synchronize with payroll and time-and-attendance. External scheduling tools write shift assignments to ProAlert for assets managed from an external production scheduling system. |
| EdgeSense Provisioning | POST /devices/register, PUT /devices/{id}/config, GET /devices/{id}/status | Automated device deployment tools register and configure EdgeSense devices at scale. Device management platforms monitor device status and push configuration updates without physical access to each device. |
| Workforce | POST /workforce/checkin, GET /workforce/shift/{shiftId}/crew, GET /workforce/labor-cost/{assetId} | Time-and-attendance systems submit crew check-in data to ProAlert for labor cost attribution. HR systems read crew records for payroll reconciliation. Labor cost endpoints feed external cost accounting systems with per-asset labor data. |
| Kiosk Provisioning | POST /kiosks, PUT /kiosks/{id}/config, DELETE /kiosks/{id} | MDM (Mobile Device Management) systems provision and deprovision kiosk tablets at scale. Enterprise device management platforms push asset assignment and shift configuration to kiosk stations without physical access to each device. |
Common Integration Scenarios
For Integration and IT Teams
| Component | Technology | Notes |
|---|---|---|
| API Protocol | REST over HTTPS, JSON (JavaScript Object Notation) request and response bodies | Standard REST architecture. All endpoints accept and return JSON. No proprietary SDK required for integration. Any HTTP client library in any language can consume the API. |
| Authentication | JWT Bearer tokens, refresh token flow | Token-based authentication compatible with all standard HTTP client libraries. Access tokens expire on configurable intervals. Refresh token flow extends sessions without re-authentication. Service account credentials supported for system-to-system integration. |
| API Documentation | OpenAPI (Swagger) specification, auto-generated from controllers | OpenAPI (formerly Swagger) documentation auto-generated from the ASP.NET Core controllers. Documentation is always current with the deployed API version. Swagger UI available at /swagger for interactive endpoint testing during integration development. |
| Network Requirements | HTTPS outbound to ProAlert server (port 443) | Only outbound HTTPS required from integrating systems. No inbound firewall rules on the ProAlert server for API consumers. Compatible with standard corporate proxy and NAT configurations. |
| Rate Limiting | Configurable per-client rate limits | API rate limiting configurable per client credential to prevent any single integration from impacting platform performance. Limits are set at the service account level in the admin interface. |
Connect ProAlert to your ERP, MES, or BI stack.
Book a 30-minute technical demo... we'll walk through the API documentation, authenticate against the sandbox environment, and demonstrate a live call initiation from a REST client.