Handbuch für Entwickler
Willkommen im Entwicklerhandbuch der hetida platform. Diese Dokumentation richtet sich an externe Entwicklerinnen und Entwickler, die die Plattform programmatisch anbinden oder erweitern möchten – etwa um Assets und Zeitreihen auszulesen, Daten zu ingestieren oder Analyse-Workflows anzustoßen.
An wen richtet sich diese Dokumentation?
- Integratoren, die eigene Systeme über die REST-Schnittstelle der Plattform anbinden.
- Datenanalystinnen und -analysten, die Analyse-Workflows im hetida designer entwickeln und ausführen.
Grundkenntnisse in HTTP/REST, JSON und OAuth2 werden vorausgesetzt. Die Codebeispiele in diesem Handbuch sind in Python gehalten, die Schnittstellen sind aber sprachunabhängig nutzbar.
Welche Möglichkeiten stehen zur Verfügung?
| Möglichkeit | Beschreibung | Kapitel |
|---|---|---|
| REST-Schnittstelle | Die vollständige Plattform-API (Assets, Tenants, Nutzer, Berechtigungen, Zeitreihen-Anbindung u. v. m.), definiert als OpenAPI-Spezifikation. | REST API |
| hetida designer | Grafische Entwicklungs- und Ausführungsumgebung für Python-basierte Analyse-Workflows. | hetida designer |
| Customizable Panels | Eigene Dashboard-Panels mit JavaScript, Apache ECharts und Tabulator entwickeln und als wiederverwendbare Vorlagen bereitstellen. | Customizable Panels |
| Weitere Schnittstellen | Feld- und Zeitreihendaten über MQTT oder OPC-UA in die Plattform einspeisen. | Weitere Schnittstellen |
Voraussetzungen
Für den Zugriff auf die REST-Schnittstelle benötigen Sie:
- Einen Tenant auf der Plattform.
- Zugangsdaten für die Authentifizierung (siehe Authentifizierung). Diese werden Ihnen vom Betreiber der Plattform bereitgestellt.
Beginnen Sie mit dem Kapitel Authentifizierung, um ein Zugriffstoken zu erhalten und den ersten API-Aufruf abzusetzen.