The OrbiSCADA API is an optional way to access your controller data outside the standard OrbiSCADA interface.
For most users, the standard OrbiSCADA interface is the best place to work day to day. It allows you to log in, view controllers, check status, and use the built-in charts and tools.
The API is intended for customers who need more flexibility than the standard interface provides. It makes it possible to connect OrbiSCADA data securely to your own tools, reports, dashboards, or software systems.
With the API, you can retrieve data in a structured format and use it in your own workflows, for example for:
- Custom reporting
- External dashboards or BI tools
- Internal monitoring tools
- Data exports for deeper analysis
- Integrations with other systems
When the API may be useful
The API may be a good option if you want to:
- Create your own reports
- Compare data in ways not available in the standard interface
- Use controller data in external dashboards or BI tools
- Export and process data for deeper analysis
- Integrate OrbiSCADA data into your own systems or workflows
Before you begin
To use the API, you need an API key linked to your user account. API keys cannot be created by users directly in the system. If you need API access, please contact support and request an API key for your user account.
Your API access follows the same permissions as your normal user account. The API does not bypass access restrictions. If your user only has access to selected controllers, or only has limited permissions, the API will follow those same limits.