projekte:etermin:start
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen der Seite angezeigt.
| Beide Seiten, vorherige ÜberarbeitungVorherige ÜberarbeitungNächste Überarbeitung | Vorherige Überarbeitung | ||
| projekte:etermin:start [14.09.2026 15:26] – [Technische Dokumentation] hwehrs | projekte:etermin:start [20.09.2026 22:18] (aktuell) – [Einleitung] hwehrs | ||
|---|---|---|---|
| Zeile 20: | Zeile 20: | ||
| wird ein neuer Interessent angelegt. | wird ein neuer Interessent angelegt. | ||
| </ | </ | ||
| - | |||
| - | ---- | ||
| <WRAP tip round 80% justify> | <WRAP tip round 80% justify> | ||
| Zeile 34: | Zeile 32: | ||
| **Teil 3 – Datenübergabe an PW**\\ | **Teil 3 – Datenübergabe an PW**\\ | ||
| Wie wird geprüft, ob die Person bereits vorhanden ist, und was geschieht anschließend? | Wie wird geprüft, ob die Person bereits vorhanden ist, und was geschieht anschließend? | ||
| + | </ | ||
| + | |||
| + | <WRAP center 80%> | ||
| + | <WRAP 80%> | ||
| + | {{: | ||
| + | </ | ||
| </ | </ | ||
| Zeile 66: | Zeile 70: | ||
| <WRAP info round 80% justify> | <WRAP info round 80% justify> | ||
| - | **Was bedeutet „Webhook“? | + | <wrap em>Was bedeutet „Webhook“? |
| Ein Webhook ist vereinfacht gesagt ein **digitaler Datenbote**. Sobald eine neue | Ein Webhook ist vereinfacht gesagt ein **digitaler Datenbote**. Sobald eine neue | ||
| Zeile 347: | Zeile 351: | ||
| Damit gilt auch im automatisierten Betrieb: | Damit gilt auch im automatisierten Betrieb: | ||
| - | **Im Zweifel kontrolliert abbrechen und nachvollziehbar protokollieren statt falsche | + | <wrap em>Im Zweifel kontrolliert abbrechen und nachvollziehbar protokollieren statt falsche Daten zu erzeugen.</ |
| - | Daten zu erzeugen.** | + | |
| </ | </ | ||
| Zeile 366: | Zeile 369: | ||
| Diese Angaben werden aus der **tatsächlich eingesetzten Implementierung** dokumentiert | Diese Angaben werden aus der **tatsächlich eingesetzten Implementierung** dokumentiert | ||
| und nicht vorab angenommen. | und nicht vorab angenommen. | ||
| + | </ | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ====== Schnittstellen / API ====== | ||
| + | |||
| + | <WRAP tip round 80% justify> | ||
| + | ===== Über welche Schnittstellen kommunizieren die Systeme? ===== | ||
| + | |||
| + | Für die automatische Verarbeitung einer eTermin-Buchung werden zwei technisch | ||
| + | unterschiedliche Schnittstellen und Kommunikationswege verwendet. | ||
| + | |||
| + | <wrap em> | ||
| + | eTermin stößt die Verarbeitung über einen **Webhook** an. Nach Abschluss einer | ||
| + | Buchung sendet eTermin die vorgesehenen Buchungsdaten selbstständig an eine | ||
| + | dafür bereitgestellte Adresse unserer Datenschnittstelle. | ||
| + | |||
| + | Die Buchungsdaten werden dabei als **JSON-Datenblock** übertragen. Dieser enthält | ||
| + | die von eTermin bereitgestellten Informationen zur Buchung und zur betreffenden | ||
| + | Person. | ||
| + | |||
| + | <wrap em> | ||
| + | Die weitere Kommunikation erfolgt über die **API von Professional Works**. | ||
| + | Unsere Datenschnittstelle übernimmt hierbei die aktive Rolle und stellt gezielte | ||
| + | HTTP-Anfragen an PW. | ||
| + | |||
| + | Je nach benötigter Aktion werden insbesondere **GET-Anfragen** zum Abrufen bzw. | ||
| + | Prüfen vorhandener Informationen und **POST-Anfragen** zur Übergabe neuer Daten | ||
| + | bzw. zum Auslösen entsprechender Aktionen verwendet. Die Antworten von | ||
| + | Professional Works werden anschließend von unserer Datenschnittstelle ausgewertet. | ||
| + | |||
| + | <wrap em>Der Zwischenstopp auf unserer Datenschnittstelle ist deshalb technisch notwendig:</ | ||
| + | Der von eTermin gelieferte JSON-Datenblock kann nicht einfach unverändert an | ||
| + | Professional Works weitergereicht werden. Die enthaltenen Daten müssen geprüft, | ||
| + | den entsprechenden PW-Datenfeldern zugeordnet und bei Bedarf um technisch | ||
| + | erforderliche Angaben ergänzt werden. Anschließend erzeugt unsere | ||
| + | Datenschnittstelle daraus die jeweils benötigten HTTP-Anfragen an die | ||
| + | Professional-Works-API. | ||
| + | |||
| + | Unsere Datenschnittstelle übernimmt damit nicht nur den Transport, sondern die | ||
| + | **Übersetzung und kontrollierte Vermittlung zwischen zwei unterschiedlichen | ||
| + | Schnittstellen**. | ||
| + | </ | ||
| + | |||
| + | < | ||
| + | flowchart LR | ||
| + | ET[" | ||
| + | |||
| + | HOOK[" | ||
| + | |||
| + | PROC[" | ||
| + | |||
| + | PW[" | ||
| + | |||
| + | ET --> | ||
| + | HOOK --> PROC | ||
| + | |||
| + | PROC --> | ||
| + | PW --> | ||
| + | </ | ||
| + | |||
| + | <WRAP info round 80% justify> | ||
| + | ===== Webhook und API – der entscheidende Unterschied ===== | ||
| + | |||
| + | **Webhook**\\ | ||
| + | Beim Webhook beginnt das sendende System die Kommunikation. eTermin meldet | ||
| + | unserer Datenschnittstelle sinngemäß: | ||
| + | |||
| + | //„Es ist etwas passiert – hier sind die Daten dazu.“// | ||
| + | |||
| + | Unsere Datenschnittstelle muss eTermin daher nicht ständig nach neuen Buchungen | ||
| + | fragen. | ||
| + | |||
| + | **API**\\ | ||
| + | Bei der Kommunikation mit Professional Works beginnt dagegen unsere | ||
| + | Datenschnittstelle die jeweilige Aktion. Sie fragt beispielsweise sinngemäß: | ||
| + | |||
| + | // | ||
| + | //„Lege diesen Interessenten an.“//\\ | ||
| + | // | ||
| + | |||
| + | Professional Works verarbeitet die Anfrage und liefert eine Antwort zurück. | ||
| + | |||
| + | <wrap em> | ||
| + | </ | ||
| + | |||
| + | <WRAP important round 80% justify> | ||
| + | ===== Technische Referenz ===== | ||
| + | |||
| + | Die konkreten technischen Angaben werden mit der tatsächlich eingesetzten | ||
| + | Implementierung dokumentiert. Dazu gehören insbesondere: | ||
| + | |||
| + | * verwendete URLs bzw. Endpunkte | ||
| + | * HTTP-Methoden und erwartete Statuscodes | ||
| + | * Authentifizierung | ||
| + | * übertragene Datenfelder und Datenformate | ||
| + | * Zuordnung eTermin-Felder → interne Verarbeitung → PW-Felder | ||
| + | * Pflichtfelder und verwendete technische Standardwerte | ||
| + | * Doublettenprüfung | ||
| + | * Fehlerantworten und deren Behandlung | ||
| + | * Versionsstand der verwendeten Schnittstellen | ||
| + | |||
| + | Diese Angaben werden **nicht aus Annahmen vorab erzeugt**, sondern aus den | ||
| + | tatsächlich eingesetzten Webhook- und API-Implementierungen übernommen. | ||
| </ | </ | ||
| ---- | ---- | ||
projekte/etermin/start.1789392380.txt.bz2 · Zuletzt geändert: von hwehrs
