Database queries can be carried out via the VCOM API in order to use them for other systems, for example.
The VCOM API is a freely programmable interface, i.e. appropriate programming knowledge is required to call up data via API:
- RESTful web services
- HTTP/1.1 conventions
- JSON format
Here you can find the VCOM-API-Documentation
Meteocontrol does not provide any support for the creation of API queries or questions about the programming of corresponding scripts!
How does the VCOM API work?
- Every Meteocontrol partner with the VCOM Service Level Basic, Pro and Premium has an API key. This API key is required for calling up the database.
- To call up data, in addition to the API key, the user data (username, password) of an existent VCOM user is required.
- The API calls are counted or processed via this one API key.
- If the number of calls or query intervals is not sufficient, further API keys can be ordered from our sales department (sales@meteocontrol.com).
- The API key can also be used for several customers. The access-rights are derived from the existing user-rights with which the data is called up. This ensures that different users can use the same API key, but can only access data from the systems for which they also have the appropriate rights in VCOM.
Where can I find the API key?
Log into VCOM with your administrator account and click on the home button 
and then on the gear symbol 
to open the administration area.
You will then find the VCOM API entry under the Portfolio > Administration menu
Which data can be accessed?
In the VCOM-API documentation you will find the available data points under "Endpoints".
(The actually available end points are partner or system-specific and can therefore vary)
Session → Shows the current user with whom the query is started
Systems → e.g. systems / <systemKey> / technical-data → List technical data for a system
Tickets → e.g. tickets / <ticketId> / histories → Shows the history of a specific ticket
CMMS → e.g. workorders / <workorderId> / forms → Shows the workorders within CMMS (still in the BETA stage)
System-specific data can only be called up by specifying the system key (e.g. "ABCDE"). The respective system key can be found in the Cockpit -> Configuration (wrench symbol):
To test queries you need a corresponding API client (e.g. Insomnia)