— REST · Schnittstellen

Partner-API: ImmoGenio sicher anbinden — mit Token, Scopes und Audit.

Die Partner-API v1 ist die Maschinen-Tür von ImmoGenio: eine REST-Schnittstelle unter /api/v1/partner/*, deren Zugriff vollständig über ein Partner-API-Token gesteuert wird. Das Token bestimmt Mandant und Scopes — Authentifizierung, Berechtigungsprüfung, Row-Level-Security, Pagination und Audit erzwingt die API, nicht der Aufrufer. Auf genau dieser Schnittstelle setzt auch der MCP-Server für KI-Agenten auf.

  • REST-Endpunkte über Objekte, Einheiten, Mieter, Mietverträge, Eigentümer sowie Eigentümerversammlungen und Beschlüsse.
  • Token-basiert: ein Partner-API-Token bestimmt Mandant, Scopes und optionales Rate-Limit.
  • Scopes nach Muster Entität:Aktion — von reinem Lesezugriff bis zu Workflow-Übergängen.
  • Abgestufte PII: Basis-Scope nur Identifikation, Kontaktdaten erst mit ReadPII, Bank- und Steuerdaten nie.
  • Mandantentrennung per Row-Level-Security; jede schreibende Aktion revisionssicher protokolliert.
  • Schreibende Endpunkte nutzen dieselben Services wie das Portal — inklusive GenioFlow-Workflows.

So einfach funktioniert es

  1. 01

    Token mit Scopes erzeugen

    Ein Tenant-Administrator legt ein Partner-API-Token mit genau den benötigten Scopes an — Lese-, Schreib- oder Workflow-Berechtigungen.

  2. 02

    Endpunkte aufrufen

    Die REST-Endpunkte unter /api/v1/partner/* mit dem Token aufrufen — die API liefert mandantengescopt und paginiert zurück.

  3. 03

    Workflows treiben

    Status und Ergebnis über die Workflow-Endpunkte durch GenioFlow treiben, statt Felder direkt zu setzen.

Eine Tür, zwei Nutzungen

Die Partner-API v1 ist die kontrollierte Außenschnittstelle von ImmoGenio. Sie wird direkt von Integrationen und eigenen Systemen genutzt — und sie ist zugleich das Fundament, auf dem der MCP-Server für KI-Agenten aufsetzt. Beide sprechen dieselbe API, mit demselben Token-, Scope- und Audit-Modell. Was über die REST-Schnittstelle nicht erlaubt ist, ist auch über die KI-Anbindung nicht erlaubt.

Token und Scopes statt offener Zugriff

Jeder Zugriff läuft über ein Partner-API-Token mit dem Präfix imp_. Ein Tenant-Administrator erzeugt es mit genau den Scopes, die eine Integration benötigt; das Token wird einmalig zurückgegeben und nur als Hash gespeichert. Scopes folgen dem Muster Entität:Aktion — etwa Objekt:Read, Mietvertrag:Transition oder Beschluss:Update — und spiegeln das Rollen- und Rechtemodell des Portals. So lässt sich eine reine Auswertungs-Integration ebenso scharf abgrenzen wie ein Dienst, der Workflows treiben darf.

Schreiben heißt Workflow, nicht Feld setzen

Schreibende Endpunkte rufen keine eigene Logik im Partner-Pfad auf, sondern dieselben geteilten Domain-Services wie die Portal-Routen — inklusive Start der GenioFlow-Workflows und der automatischen Folge-Übergänge. Status und Ergebnis werden daher nicht als Datenfeld gesetzt, sondern über Workflow-Endpunkte getrieben: aktuellen Zustand und erlaubte Aktionen abfragen, dann genau einen geprüften Übergang ausführen. Die Mandantentrennung per Row-Level-Security und der revisionssichere Audit-Trail gelten dabei für jeden Aufruf.

Häufige Fragen

Wie authentifiziert sich ein Aufruf gegen die Partner-API?

Über ein Partner-API-Token (Präfix imp_). Ein Tenant-Administrator erzeugt es mit den gewünschten Scopes; es wird einmalig zurückgegeben und nur als Hash gespeichert. Das Token bestimmt Mandant, Berechtigungen und ein optionales Rate-Limit. Authentifizierung, Scope-Prüfung, Mandantentrennung, Pagination und Audit erzwingt die API — nicht der Aufrufer.

Wie funktionieren die Scopes?

Scopes folgen dem Muster Entität:Aktion, etwa Objekt:Read, Mietvertrag:Transition oder Beschluss:Update. Sie spiegeln das Rollen- und Rechtemodell des Portals. Ein Token kann gezielt nur das freigeben, was eine Integration tatsächlich braucht — von reinem Lesezugriff bis zu schreibenden Aktionen.

Wie sind personenbezogene Daten geschützt?

Abgestuft. Der Basis-Scope liefert nur Identifikationsdaten; Kontaktdaten wie E-Mail, Telefon oder Anschrift erfordern einen separaten ReadPII-Scope. Bank- und Steuerdaten (IBAN, BIC, Steuer-ID) werden grundsätzlich nie ausgeliefert. Die Mandantentrennung erzwingt PostgreSQL über Row-Level-Security auf Datensatz-Ebene.

Werden schreibende Aufrufe protokolliert?

Ja. Jede schreibende Aktion über die Partner-API erzeugt einen revisionssicheren Audit-Eintrag. Schreibende Endpunkte nutzen zudem dieselben geteilten Domain-Services wie das Portal — inklusive Start der GenioFlow-Workflows und der automatischen Folge-Übergänge.

Bereit, Ihre Verwaltung zu digitalisieren?

45 Tage volle Professional-Suite testen — Tarif-Wahl erst nach dem Test, ohne Bankdaten.