Files
HiveGrid-Wireframes/03 Quellen und Referenzen/hivegrid-cloud/.planning/ticket-docs/EXT-18.md
T

72 lines
4.1 KiB
Markdown

# EXT-18 · BauHow Test-Workspace + OAuth-/API-Vertrag klären
| | |
|---|---|
| **Typ** | Setup (External) |
| **Owner** | Raffael |
| **Plane** | `HIV-217` |
| **Cycle/Fenster** | ungeplant · vor dem Bau von `R-BAUHOW` |
| **Status** | In Progress · **1/6 DoD = ~17 % done** · Mail an Nick geschrieben, Rückmeldung offen |
## Was zu tun ist
Mit Nick von BauHow den belastbaren Zugangs- und Integrationsvertrag für einen HiveGrid-Connector klären. Es
werden bewusst **keine unbestätigten BauHow-Funktionen vorausgesetzt**. Bekannt ist nur, dass Raffael die API
bereits über Noah gesehen hat; daraus folgt noch kein freigegebener Testzugang oder OAuth-Vertrag.
Der in der Mail beschriebene vorläufige HiveGrid-Scope ist:
- einen BauHow-Account mit HiveGrid verbinden,
- Kunden-, Projekt- und Gebäudedaten im vereinbarten Minimalumfang übertragen,
- das zugehörige BauHow-Projekt aus HiveGrid öffnen,
- Status, Ergebnisse und Dokumente synchronisieren, soweit die BauHow-API diese Vorgänge tatsächlich trägt.
## Angefragter Partner-Input
1. **Test-Workspace:** separater Testzugang mit API-Zugriff und realistischen, nicht produktiven Testdaten.
2. **OAuth-App:** Kann HiveGrid selbst eine OAuth-App anlegen und verwalten oder legt BauHow sie für uns an?
3. **OAuth-Vertrag:** Client-ID/-Secret, Authorization-/Token-Endpunkte, Scopes, Refresh-/Revocation-Verhalten
und Bindung der Autorisierung an Nutzer beziehungsweise Organisation/Workspace.
4. **Redirect-URIs:** Unterstützung fester Callback-URLs für lokal, Staging und Produktion. Nach dem
HiveGrid-Routenvertrag wären dies, sofern BauHow sie akzeptiert:
- `http://localhost:3000/integrations/bauhow/oauth/callback`
- `https://staging-app.hivegrid.de/integrations/bauhow/oauth/callback`
- `https://app.hivegrid.de/integrations/bauhow/oauth/callback`
5. **Direkter Projekteinstieg:** Unterstützter SSO-, Deep-Link- oder vergleichbarer Mechanismus, mit dem ein
autorisierter Nutzer das verknüpfte Projekt ohne erneute Anmeldung öffnen kann.
6. **API-Unterlagen:** aktuelle Dokumentation und Setup-Schritte sowie die tatsächlich unterstützten
Ressourcen für Kunden, Projekte, Gebäude, Status, Ergebnisse und Dokumente; außerdem Webhooks oder die
empfohlene Alternative für den Rückkanal.
## Abhängigkeiten
- **blocked-by:** Rückmeldung und Bereitstellung durch Nick/BauHow (extern)
- **blocks:** `R-BAUHOW`
- **Auswirkung auf den Abhängigen:** `R-BAUHOW` bleibt bis zur dokumentierten Antwort auf **Blocked / On Hold**.
Insbesondere werden OAuth, API-Token, SSO/Deep-Link, Scopes und Sync-Richtung nicht vorab erfunden.
## Definition of Done
- [x] Initiale Mail an Nick mit kurzem HiveGrid-Scope sowie Fragen zu Test-Workspace, OAuth-App, Callback-URLs,
direktem Projekteinstieg und API-Unterlagen geschrieben
- [ ] Separater Test-Workspace mit nutzbarem API-Zugang und Testdaten ist bereitgestellt
- [ ] OAuth-App-Modell ist geklärt: Self-Service oder Provisionierung durch BauHow, inklusive Client-Credentials
- [ ] OAuth-Vertrag ist dokumentiert: Endpunkte, Redirect-URIs, Scopes, Token-Lifecycle und Nutzer-/Org-Bindung
- [ ] Unterstützter Vertrag für den direkten Projekteinstieg ohne zweite Anmeldung ist dokumentiert
- [ ] Aktuelle API-Unterlagen und der bestätigte Daten-/Sync-Umfang liegen vor
## Umsetzungs-Notiz
- **2026-08-01 · 1/6 DoD = ~17 % done:** Raffael hat die initiale Mail an Nick geschrieben. Sie nennt nur den
geplanten HiveGrid-Integrationsscope und fragt nach Test-Workspace, OAuth-App beziehungsweise eigener
App-Erstellung, Callback-URLs, Client-Credentials, OAuth-Endpunkten/Scopes, Token-Lifecycle, direktem
Projekteinstieg und aktueller API-Dokumentation. Offen: fünf Punkte; davon fünf durch BauHow-Input blockiert,
sobald die Anfrage bei Nick liegt. Es wird ausdrücklich noch nicht behauptet, dass BauHow OAuth/OIDC,
SSO/Deep-Links oder alle genannten Sync-Ressourcen anbietet.
## Quellen
- Anfrage und Mail-Stand von Raffael, 2026-08-01
- `docs/INTEGRATION-CONTRACTS.md` §3 (kanonischer Connector-Callback)
- `.planning/ticket-docs/R-P5.md` (bestehende Apps-Engine und `DataConnection`-Vertrag)