VCOM-API

Zuletzt geändert: 2026-05-27

Über die VCOM API

Mit der VCOM-API können Sie VCOM-Daten mit anderen Anlagen integrieren. Um auf die VCOM-API zugreifen zu können, benötigen Sie ein gültiges VCOM-Benutzerkonto und einen API-Key. API-Keys werden auf der Portfolioebene erstellt und gelten für alle Anlagen innerhalb dieses Portfolios. Die über die API zugänglichen Daten hängen von den Berechtigungen des zugehörigen Benutzerkontos ab.

Die API unterstützt den Austausch von Daten im Text/JSON-Format (keine Bilder). Je nach API-Endpunkt sind die Daten entweder nur lesbar oder können erstellt und geändert werden.

Zielgruppe

Die VCOM-API richtet sich an Benutzer und Partner, die VCOM-Daten in ihre eigenen Anwendungen oder Arbeitsabläufe integrieren möchten. Grundlegende Programmierkenntnisse sind erforderlich.

Detaillierte technische Informationen, wie verfügbare Endpunkte, Abfrageparameter, Authentifizierungsdetails und Antwortformate, sind in der VCOM-API-Dokumentation enthalten. Um über VCOM auf die Dokumentation zuzugreifen, gehen Sie in die obere Navigationsleiste und wählen Sie Hilfe > Developer Space.

Typische Anwendungsfälle

• Messdaten nach BI-Tools exportieren

• Ticketdaten mit Servicepartnern synchronisieren

• Berichterstattung über mehrere Portfolios automatisieren

Nutzungslimits

Jede Service-Level umfasst einen API-Key mit definierten Abfragegrenzen. Falls Sie ein höheres Abfragevolumen benötigen, können Sie zusätzliche API-Keys erwerben. Um den Key zu aktivieren, siehe VCOM-API einrichten.

Sicherheits- und Nutzungsnotizen

• Wir empfehlen, für den API-Zugriff ein separates, eigens dafür vorgesehenes Benutzerkonto einzurichten, um die Sicherheit zu erhöhen und die Nachverfolgung zu vereinfachen.

  • Sie können auch dafür eine benutzerdefinierte Gruppe erstellen ( PREMIUM-PARTNER ).

• Speichern Sie Anmeldeinformationen und API-Key sicher.

• Sie können nur einzelne Benutzer vom Zugriff auf die API ausschließen, indem Sie das Konto löschen.

• Sollte ein API-Key beeinträchtigt sein, deaktivieren Sie ihn und erstellen Sie einen neuen.

• Überwachen Sie Ihre API-Nutzung, um innerhalb ihres Plans zu bleiben.

• JSON ist das Standardformat für alle Endpunkte.

• Implementieren Sie eine saubere Fehlerbehandlung in Ihrem Code.

VCOM API einrichten

• Sie sind ein bestehender VCOM-Partner.

• Benutzergruppe Administrator

1. In VCOM auf der PORTFOLIOEBENE , gehen Sie zu Portfolioeinstellungen > Verwaltung > VCOM API.

2. Wenn Sie noch keinen API-Key haben, geben Sie eine Beschreibung Ihrer API ein.

3. Wählen Sie den passenden API-Plan aus. Dies bezieht sich auf die täglich erlaubten Anzahl der API-Aufrufe/Abfragen.

4. Wählen Sie Kostenpflichtige API-Key erstellen. Der Schlüssel wird Ihrem Konto belastet.

In der Tabelle werden die Details für jeden von Ihnen erworbenen Schlüssel angezeigt. Sie können jetzt die API-Keys verwenden, z. B. zur Authentifizierung.

• Einen bestehenden API-Key aktualisieren: Bitte kontaktieren Sie sales@meteocontrol.com

• Zusätzliche API-Keys erwerben: Wählen Sie Ihren gewünschten API-Plan aus und wählen Sie Bezahlten API-Key erstellen. Zusätzliche API-Keys werden mit Ihrer vierteljährlichen VCOM-Abrechnung in Rechnung gestellt.

• Einen API-Key ungültig machen: Wählen Sie in der Aktion-Spalte Löschen.

Ihren VCOM API-Key finden

• Sie haben die VCOM API bereits eingerichtet.

1. In VCOM auf der PORTFOLIOEBENE , gehen Sie zu Portfolioeinstellungen > Verwaltung > VCOM API.

2. Suchen Sie in der Tabelle der API-Keys den relevanten API-Key.

3. Kopieren Sie den API-Key.

Sie können jetzt den Key verwenden.