meteocontrol Knowledge Base - VCOM - VCOM API Schnittstelle

Über die VCOM API können Datenbankabfragen durchgeführt werden, um diese z.B. wiederum für andere Systeme zu verwenden.

Die VCOM API ist eine frei programmierbare Schnittstelle, d.h. zum Abruf von Daten via API sind entsprechende Programmierkenntnisse erforderlich:

Hier finden Sie die entsprechende VCOM-API-Dokumentation

Meteocontrol stellt keinen Support für die Erstellung von API-Abfragen oder Fragen zur Programmierung entsprechender Skripte zur Verfügung!

Jeder Meteocontrol-Partner mit dem VCOM Service Level Basic, Pro sowie Premium verfügt über einen API-Key. Dieser API-Key ist für den Datenbank Aufruf notwendig.
Für den Abruf von Daten sind zusätzlich zum API-Key die Benutzerdaten (Benutzername, Passwort) eines in VCOM angelegten Benutzers notwendig.
Die API Aufrufe werden über diesen einen API-Key gezählt bzw. abgearbeitet.
Sollte die Anzahl der Aufrufe bzw. Abfrageintervalle nicht ausreichend sein, so können weitere API Keys über unseren Vertrieb (vertrieb@meteocontrol.de) bestellt werden.
Der API-Key kann auch für mehrere Kunden verwendet werden. Die Zugriffsrechte leiten sich von den bestehenden Benutzerrechten ab, mit der die Daten abgerufen werden. So ist sichergestellt, dass verschiedene Benutzer zwar den selben API-Key verwenden können, jedoch nur Daten von den Anlagen abrufen können, wozu Sie auch in VCOM die entsprechenden Rechte besitzen.

Loggen Sie sich mit Ihrem Administrator-Account in VCOM ein und klicken Sie auf den Home-Button

und anschließend auf das Zahnrad-Symbol

um den Administrationsbereich zu öffnen.

Unter dem Menü Portfolio > Administration finden Sie dann den Eintrag VCOM API

In der VCOM-API Dokumentation finden Sie unter "Endpoints" die zur Verfügung stehenden Datenpunkte.

(Die real zur Verfügung stehenden Endpunkte sind Partner- bzw. Anlagenspezifisch und können daher variieren)

Session → Zeigt den aktuellen Benutzer an mit dem die Abfrage gestartet wird

Systems → z.B. systems/<systemKey>/technical-data → Technische Daten für eine Anlage auflisten

Tickets → z.B. tickets/<ticketId>/histories → Zeigt die Historie von einem bestimmten Ticket an

CMMS → z.B. workorders/<workorderId>/forms → Zeigt die Arbeitsaufträge innerhalb von CMMS an (noch im BETA Stadium)

Anlagenspezifische Daten können nur durch Angabe des Anlagenschlüssels abgerufen werden, (z.B. "ABCDE").

Den jeweiligen Anlagenschlüssel finden Sie auf im Cockpit -> Konfiguration (Schraubenschlüssel-Symbol):

Zum Testen von Abfragen benötigen Sie einen entsprechenden API-Client (z.B. Insomnia)

Eine Übersicht über die verfügbaren Kürzel und deren Bedeutung finden Sie anbei.