Seminar ThingsBoard CE/PE – REST API, WebSockets und Automatisierung

Das Seminar erschließt die programmatische Steuerung und Integration der Plattform. Authentisierung, REST-Ressourcen, Entity Query, Telemetrie, Attribute, Geräteverwaltung, Alarm- und Dashboardobjekte, WebSocket-Subscriptions, Fehlerbehandlung, Idempotenz und sichere Automatisierungsabläufe werden praktisch umgesetzt.

Inhaltsverzeichnis

• Lernziele und fachliche Einordnung.
• Schrittweise Seminarinhalte.
• Praxisübungen und Laborszenarien.
• Zielgruppe und Voraussetzungen.
• Didaktik und Arbeitsweise.

Lernziele

• API-Authentisierung, Rollen und Ressourcengrenzen sicher konfigurieren.
• Entitäten, Telemetrie, Attribute, Relationen und Alarme über REST kontrolliert verarbeiten.
• Echtzeitdaten über WebSocket-Subscriptions zuverlässig abonnieren.
• Automatisierungen idempotent, fehlertolerant, protokolliert und wiederaufnehmbar gestalten.
• API-Clients durch Tests, Secret-Management, Versionskontrolle und Betriebskennzahlen produktionsreif machen.

Schrittweise Seminarinhalte

1. API-Architektur und Sicherheitsmodell

Schwerpunkt: REST-Endpunkte, Base URL, HTTPS, Benutzer- und Dienstidentitäten, JWT, Token-Lebensdauer, Rollen, Customer-Grenzen, Rate Limits und Audit.

1. Ausgangslage, Schutzbedarf, technische Randbedingungen und Abnahmekriterien für den Themenblock „API-Architektur und Sicherheitsmodell“ erfassen.
2. Relevante Komponenten, Entitäten, Rollen, Schnittstellen und Abhängigkeiten anhand von REST-Endpunkte, Base URL, HTTPS, Benutzer- und Dienstidentitäten, JWT, Token-Lebensdauer, Rollen, Customer-Grenzen, Rate Limits und Audit modellieren.
3. Die erforderliche Konfiguration oder Prozessfolge in einer kontrollierten Laborumgebung schrittweise umsetzen und jeden Zwischenstand protokollieren.
4. Funktion, Berechtigungen, Datenfluss, Protokollierung, Fehlerverhalten und Grenzfälle mit definierten Positiv- und Negativtests prüfen.
5. Als Arbeitsergebnis eine abgesicherte API-Zugriffsarchitektur dokumentieren, fachlich abnehmen und in einen wiederholbaren Betriebs- oder Entwicklungsstandard überführen.

2. Authentisierung und Sessionbehandlung

Schwerpunkt: Login, Access Token, Refresh Token, Ablauf, Fehlercodes, Secret-Speicherung, Rotation, parallele Prozesse und sichere Abmeldung.

1. Ausgangslage, Schutzbedarf, technische Randbedingungen und Abnahmekriterien für den Themenblock „Authentisierung und Sessionbehandlung“ erfassen.
2. Relevante Komponenten, Entitäten, Rollen, Schnittstellen und Abhängigkeiten anhand von Login, Access Token, Refresh Token, Ablauf, Fehlercodes, Secret-Speicherung, Rotation, parallele Prozesse und sichere Abmeldung modellieren.
3. Die erforderliche Konfiguration oder Prozessfolge in einer kontrollierten Laborumgebung schrittweise umsetzen und jeden Zwischenstand protokollieren.
4. Funktion, Berechtigungen, Datenfluss, Protokollierung, Fehlerverhalten und Grenzfälle mit definierten Positiv- und Negativtests prüfen.
5. Als Arbeitsergebnis einen robusten Authentisierungs- und Tokenprozess dokumentieren, fachlich abnehmen und in einen wiederholbaren Betriebs- oder Entwicklungsstandard überführen.

3. Entity CRUD und Abfragen

Schwerpunkt: Devices, Assets, Customers, Users, Profiles, Pagination, Sortierung, Text Search, Entity Query, Relations und externe Schlüssel.

1. Ausgangslage, Schutzbedarf, technische Randbedingungen und Abnahmekriterien für den Themenblock „Entity CRUD und Abfragen“ erfassen.
2. Relevante Komponenten, Entitäten, Rollen, Schnittstellen und Abhängigkeiten anhand von Devices, Assets, Customers, Users, Profiles, Pagination, Sortierung, Text Search, Entity Query, Relations und externe Schlüssel modellieren.
3. Die erforderliche Konfiguration oder Prozessfolge in einer kontrollierten Laborumgebung schrittweise umsetzen und jeden Zwischenstand protokollieren.
4. Funktion, Berechtigungen, Datenfluss, Protokollierung, Fehlerverhalten und Grenzfälle mit definierten Positiv- und Negativtests prüfen.
5. Als Arbeitsergebnis eine wiederverwendbare Verwaltungs- und Suchbibliothek dokumentieren, fachlich abnehmen und in einen wiederholbaren Betriebs- oder Entwicklungsstandard überführen.

4. Telemetrie und Attribute per API

Schwerpunkt: Latest Values, Zeitreihen, Zeitbereiche, Aggregation, Server-, Shared- und Client-Attribute, Batch-Verarbeitung, Zeitstempel und Datenvalidierung.

1. Ausgangslage, Schutzbedarf, technische Randbedingungen und Abnahmekriterien für den Themenblock „Telemetrie und Attribute per API“ erfassen.
2. Relevante Komponenten, Entitäten, Rollen, Schnittstellen und Abhängigkeiten anhand von Latest Values, Zeitreihen, Zeitbereiche, Aggregation, Server-, Shared- und Client-Attribute, Batch-Verarbeitung, Zeitstempel und Datenvalidierung modellieren.
3. Die erforderliche Konfiguration oder Prozessfolge in einer kontrollierten Laborumgebung schrittweise umsetzen und jeden Zwischenstand protokollieren.
4. Funktion, Berechtigungen, Datenfluss, Protokollierung, Fehlerverhalten und Grenzfälle mit definierten Positiv- und Negativtests prüfen.
5. Als Arbeitsergebnis einen kontrollierten Datenlese- und Schreibprozess dokumentieren, fachlich abnehmen und in einen wiederholbaren Betriebs- oder Entwicklungsstandard überführen.

5. Alarme, Dashboards und Konfigurationsobjekte

Schwerpunkt: Alarmabfragen, Quittierung, Löschung, Dashboardexport, Rule-Chain-Objekte, Geräteprofile, Versionierung, Abhängigkeiten und Berechtigungen.

1. Ausgangslage, Schutzbedarf, technische Randbedingungen und Abnahmekriterien für den Themenblock „Alarme, Dashboards und Konfigurationsobjekte“ erfassen.
2. Relevante Komponenten, Entitäten, Rollen, Schnittstellen und Abhängigkeiten anhand von Alarmabfragen, Quittierung, Löschung, Dashboardexport, Rule-Chain-Objekte, Geräteprofile, Versionierung, Abhängigkeiten und Berechtigungen modellieren.
3. Die erforderliche Konfiguration oder Prozessfolge in einer kontrollierten Laborumgebung schrittweise umsetzen und jeden Zwischenstand protokollieren.
4. Funktion, Berechtigungen, Datenfluss, Protokollierung, Fehlerverhalten und Grenzfälle mit definierten Positiv- und Negativtests prüfen.
5. Als Arbeitsergebnis einen automatisierbaren Konfigurations- und Alarmworkflow dokumentieren, fachlich abnehmen und in einen wiederholbaren Betriebs- oder Entwicklungsstandard überführen.

6. WebSocket-Subscriptions und Echtzeitdaten

Schwerpunkt: WebSocket-Verbindung, Authentisierung, Subscription Commands, Timeseries, Attributes, Alarms, Unsubscribe, Reconnect, Heartbeat und Backpressure.

1. Ausgangslage, Schutzbedarf, technische Randbedingungen und Abnahmekriterien für den Themenblock „WebSocket-Subscriptions und Echtzeitdaten“ erfassen.
2. Relevante Komponenten, Entitäten, Rollen, Schnittstellen und Abhängigkeiten anhand von WebSocket-Verbindung, Authentisierung, Subscription Commands, Timeseries, Attributes, Alarms, Unsubscribe, Reconnect, Heartbeat und Backpressure modellieren.
3. Die erforderliche Konfiguration oder Prozessfolge in einer kontrollierten Laborumgebung schrittweise umsetzen und jeden Zwischenstand protokollieren.
4. Funktion, Berechtigungen, Datenfluss, Protokollierung, Fehlerverhalten und Grenzfälle mit definierten Positiv- und Negativtests prüfen.
5. Als Arbeitsergebnis einen stabilen Echtzeit-Abonnementprozess dokumentieren, fachlich abnehmen und in einen wiederholbaren Betriebs- oder Entwicklungsstandard überführen.

7. Idempotenz, Fehlerbehandlung und Orchestrierung

Schwerpunkt: Retries, Timeouts, Korrelations-IDs, Duplikate, Teilzustände, Paging, Transaktionsgrenzen, Checkpoints, Kompensation und Dead-Letter-Verarbeitung.

1. Ausgangslage, Schutzbedarf, technische Randbedingungen und Abnahmekriterien für den Themenblock „Idempotenz, Fehlerbehandlung und Orchestrierung“ erfassen.
2. Relevante Komponenten, Entitäten, Rollen, Schnittstellen und Abhängigkeiten anhand von Retries, Timeouts, Korrelations-IDs, Duplikate, Teilzustände, Paging, Transaktionsgrenzen, Checkpoints, Kompensation und Dead-Letter-Verarbeitung modellieren.
3. Die erforderliche Konfiguration oder Prozessfolge in einer kontrollierten Laborumgebung schrittweise umsetzen und jeden Zwischenstand protokollieren.
4. Funktion, Berechtigungen, Datenfluss, Protokollierung, Fehlerverhalten und Grenzfälle mit definierten Positiv- und Negativtests prüfen.
5. Als Arbeitsergebnis einen fehlertoleranten Automatisierungsworkflow dokumentieren, fachlich abnehmen und in einen wiederholbaren Betriebs- oder Entwicklungsstandard überführen.

8. Tests, Deployment und Betrieb

Schwerpunkt: Testmandant, Mockdaten, Contract Tests, Negativtests, Logging, Metriken, Secret-Rotation, Versionierung, Scheduler, Rollback und Runbook.

1. Ausgangslage, Schutzbedarf, technische Randbedingungen und Abnahmekriterien für den Themenblock „Tests, Deployment und Betrieb“ erfassen.
2. Relevante Komponenten, Entitäten, Rollen, Schnittstellen und Abhängigkeiten anhand von Testmandant, Mockdaten, Contract Tests, Negativtests, Logging, Metriken, Secret-Rotation, Versionierung, Scheduler, Rollback und Runbook modellieren.
3. Die erforderliche Konfiguration oder Prozessfolge in einer kontrollierten Laborumgebung schrittweise umsetzen und jeden Zwischenstand protokollieren.
4. Funktion, Berechtigungen, Datenfluss, Protokollierung, Fehlerverhalten und Grenzfälle mit definierten Positiv- und Negativtests prüfen.
5. Als Arbeitsergebnis einen produktionsreifen API-Client mit Betriebsstandard dokumentieren, fachlich abnehmen und in einen wiederholbaren Betriebs- oder Entwicklungsstandard überführen.

Praxisübungen und Laborszenarien

• Entwicklung eines API-Clients für Suche, Anlage und Aktualisierung von Geräten.
• Automatisierter Import von Telemetrie und Attributen mit Validierung und Fehlerprotokoll.
• Aufbau einer WebSocket-Subscription für Echtzeitwerte und Alarme.
• Implementierung eines idempotenten Joiner- und Leaver-Workflows mit Wiederaufnahme.

Zielgruppe und Voraussetzungen

Zielgruppe: Softwareentwicklung, Systemintegration, DevOps, Datenengineering, Plattformadministration und technische Automatisierung.

Voraussetzungen: Programmier- oder Skriptingpraxis, HTTP- und JSON-Grundlagen sowie Grundkenntnisse der ThingsBoard-Entitäten.

Didaktik und Arbeitsweise

Kurze Fachimpulse werden unmittelbar durch Demonstrationen, strukturierte Konfigurationsschritte, praktische Übungen und kontrollierte Fehlerfälle vertieft. Jede Übung verwendet definierte Ausgangswerte, Prüfpunkte und Dokumentationsanforderungen. Dadurch entstehen nachvollziehbare Abläufe, die sich auf Entwicklungs-, Test- und Produktionsumgebungen übertragen lassen.