teroa™ - closer together.

TEROA Developer

Eine API für sichere digitale Hausgemeinschaften.

Die öffentliche REST-Schnittstelle von TEROA ist unter https://api.teroa.de erreichbar. Der OpenAPI-3.1-Vertrag ist die verbindliche technische Referenz.

OpenAPI YAML ladenSchnellstart
Produktionsbasishttps://api.teroa.de
AuthentifizierungBearer Access Token
DatenformatJSON über HTTPS
ZugriffsmodellMandanten- und Rollenprüfung serverseitig

Schnellstart

Erste öffentliche Anfrage

Rechtliche Dokumentversionen und der Health-Endpunkt benötigen keine Anmeldung. Geschützte Ressourcen erwarten einen Access Token im Authorization-Header.

curl --fail --silent https://api.teroa.de/v1/legal/versions
curl --fail --silent -H "Authorization: Bearer <access-token>" https://api.teroa.de/v1/flat/operator

Ressourcen

API-Bereiche

Die Kurzbeschreibung dient der Orientierung. Pfade, Schemas, Statuscodes und Pflichtfelder stehen vollständig im OpenAPI-Vertrag.

Konten & Sitzungen

Anmeldung, Sitzungen und Datenrechte.

/v1/auth/session/v1/account/sessions/v1/account/export

Hausgemeinschaft

Strukturen, Einladungen und Freigaben.

/v1/communities/v1/invites/v1/join-requests

Alltagsmodule

Pakete, Mängel und Abstimmungen.

/v1/packages/v1/issues/v1/polls

Nachbarschaftshilfe & Push

Fragen im Hausboard können Nachbarschaftshilfe auslösen. Mitglieder können Push dafür kontoweit abschalten; die Anfrage bleibt im Board und Posteingang sichtbar.

/v1/houseboard/posts/v1/push/preferences/v1/notifications

TEROA Flat

WG-Profile, geschützte Zugänge, verschlüsselte Bewohner-/Gast-WLAN-Profile sowie redaktionelles und verschlüsseltes PDF-Handbuch.

/v1/flat/operator/v1/flat/resident/v1/flat/areas/{flatId}/wifi/v1/flat/areas/{flatId}/wifi/{audience}/v1/flat/areas/{flatId}/handbook/v1/flat/areas/{flatId}/handbook-document

TEROA Villas

Speisekarte und Angebote mit Vorbestellung im Aufenthaltszeitraum, Gastgeber-Push sowie geschützte Gastzugänge und WLAN-Profile.

/v1/villas/public/{token}/v1/villas/guest/{token}/v1/villas/guest/{token}/order-catalog/v1/villas/guest/{token}/wifi/v1/villas/guest/{token}/orders/v1/villas/manage/properties/v1/villas/manage/properties/{propertyId}/wifi

Smartlock-Zugang

Geschützter PIN-Abruf über einen Schlossanbieter. Die Zuordnung ist an Property und aktive Mitgliedschaft oder Aufenthalt gebunden; TEROA ändert keine Codes am Schloss.

/v1/smartlocks/flat/{flatId}/me/v1/villas/guest/{token}/smartlocks/v1/smartlocks/manage/{propertyId}

Nuki Opener

GET meldet die Verfügbarkeit für aktive Bewohner oder private Villa-Gastzugänge. POST sendet nach Bestätigung der App eine gedrosselte Öffnungsanfrage. Der Server prüft Property, Zugang und Nuki-Opener-Gerätetyp vor der Aktion; öffentliche Handbuchlinks sind ausgeschlossen.

/v1/smartlocks/flat/{flatId}/opener/v1/villas/guest/{token}/opener

Vertrag

Versioniert und maschinenlesbar

Der veröffentlichte Vertrag enthält ausschließlich die Produktionsbasis. Lokale Entwicklungsadressen, Testidentitäten und interne Betriebsdaten werden nicht publiziert.

OpenAPI 3.1 öffnen

TEROA Flat Beta

Sichere Einstiegspunkte

Der Produktivzugang verwendet das bestehende TEROA-Konto und zeitlich begrenzte Flat-Mitgliedschaften. Für unbeaufsichtigte Server-zu-Server-Integrationen ist derzeit bewusst kein persönlicher Dauertoken vorgesehen.

Android Beta

Signierte Sideload-Beta und Hinweise zum geschlossenen Google-Play-Test.

Android Beta öffnen

iOS Beta

Die aktuelle iOS-Beta wird intern über TestFlight verteilt. Es gibt noch keinen öffentlichen Einladungslink.

Zugang über Support klären

Integrationen

Interaktive Clients nutzen Bearer-Sitzungen. Ein widerrufbarer, eng begrenzter Operator-Connector ist noch nicht Teil des öffentlichen Vertrags.

Vertrag prüfen