# Fairwalter Public API

> Fairwalter Public API

Mit der Fairwalter Public API können Sie Ihre im System erfassten Daten flexibel abfragen und nahtlos in externe Systeme, eigene Dashboards oder individuelle KI-Anwendungen einbinden. In diesem Artikel erfahren Sie alles über Voraussetzungen, verfügbare Daten und technische Rahmenbedingungen.

:::note
Die Public API ist ab dem Abonnement Professional verfügbar.
:::

Die Aktivierung der Schnittstelle sowie das Generieren von API-Tokens kann **ausschliesslich von Benutzern mit der Rolle Kontoinhaber** ausgeführt werden. ([Benutzerrollen](/benutzerrollen-und-berechtigungen/))

:::tip
### Gut zu wissen: Was ist eine API und was kann ich damit machen?

**API** steht für _Application Programming Interface_ (Programmierschnittstelle). Man kann sich eine API wie eine digitale Brücke vorstellen, über die zwei verschiedene Software-Systeme automatisch und sicher Daten miteinander austauschen können.

**Wofür kann ich die Fairwalter API nutzen?**

-   **Eigene Dashboards & Berichte:** Verknüpfen Sie Fairwalter mit Analyse-Tools wie _Power BI_ oder _Excel_, um eigene, automatisierte Berichte und Kennzahlen zu erstellen.
-   **Drittsysteme anbinden:** Übertragen Sie Liegenschafts-, Mieter- oder Finanzdaten automatisch in Ihr Buchhaltungsprogramm, CRM, Mieterportal oder auf Ihre eigene Website.
-   **KI & Automation:** Nutzen Sie die Daten als Grundlage für eigene Chatbots, KI-Assistenten oder automatisierte Workflows.
:::

## Überblick & technische Spezifikationen

| **Eigenschaft** | **Details** |
| --- | --- |
| **Funktion & Zugriff** | Lesezugriff (Read-only) live auf Ihre Daten |
| **Abrufbare Datenbereiche**  | Mandate, Liegenschaften, Gebäude und Objekte\
Verträge, Mieter und Personen\
Buchhaltung\
Räume, Assets, Schäden und Dienstleister\
Dokumente |
| **Format & Architektur** | RESTful API mit JSON-Format |
| **Authentifizierung** | API-Token, erstellt über die Integration in Fairwalter (nur für Kontoinhaber) |
| **Dokumentation** | [Fairwalter Public API Dokumentation](https://my.fairwalter.ch/public-api/docs#description/modes) |

## Public API aktivieren und Token erstellen

1.  Klicken Sie oben rechts auf Ihren Profilnamen und wählen Sie **Integrationen**.
2.  Klicken Sie beim Punkt **Public API** auf **Integration verwalten**.
3.  Klicken Sie auf **Aktivieren**.
4.  Klicken Sie auf **Token hinzufügen**, geben Sie einen **Name** ein und wählen Sie unter **Mandatszugriff** **Alle Mandate (auch zukünftige)** oder **Spezifische Mandate**. Optional erfassen Sie **Notizen** und ein **Ablaufdatum**.
5.  Kopieren Sie den Token im Fenster **Token erstellt** und bewahren Sie ihn sicher auf: Fairwalter kann ihn nicht erneut anzeigen.

:::note[Screenshot]
Hier gehört ein Screenshot der Seite **Public API** mit dem Button **Token hinzufügen** hin.
:::

## Wichtige Hinweise für Kunden, Entwickler und IT-Partner

-   **Aktivierung & Rechte:** Der Zugriff auf den Menüpunkt **Integrationen** sowie die Erstellung von API-Keys ist Kontoinhabern vorbehalten.\
    Weitere Details finden Sie unter [Benutzerrollen und Berechtigungen](/benutzerrollen-und-berechtigungen/).
-   **Keine Schreibrechte:** Es können derzeit keine Daten nach Fairwalter zurückgeschrieben werden (bislang nicht verfügbar).
-   **Eigenständige Anbindung:** Fairwalter stellt die Schnittstelle und Dokumentation bereit, bietet jedoch keinen Entwicklungs-Support. Entwickler können die REST-API als Basis für eigene KI-Integrationen nutzen, empfohlen ist jedoch, den MCP-Server zu nutzen.
-   **KI- und Agenten-Anbindung:** Ein fertiger MCP-Server (Model Context Protocol) steht allen Kunden ab dem Abonnement Professional zur Verfügung.
-   **Sicherheit:** Behandeln Sie API-Token wie Passwörter. Speichern Sie sie nicht in öffentlichen Dokumenten, Screenshots oder Support-Tickets. Bauen Sie API-Token nie direkt in Webseiten ein. Wer das API-Token besitzt, hat vollen Zugriff auf Ihre Daten. Dies gilt auch für AI-Chatbots.

## Häufig gestellte Fragen (FAQ)

-   **Wie aktuell sind die Daten über die API?**\
    Die Schnittstelle greift live auf Fairwalter zu. Sobald eine Änderung im System gespeichert wird, ist sie unmittelbar über die API abrufbar.
-   **Werden Filterung und Sortierung unterstützt?**\
    Ja. Abfragen können über URL-Parameter gezielt gefiltert und sortiert werden. Grössere Datenmengen (z. B. viele Buchungen oder Objekte) werden automatisch seitenweise zurückgegeben.

-   **Gibt es Abruflimits (Rate-Limits)?**\
    Ja, zum Schutz der Systemstabilität bestehen Rate-Limits. Die genauen Vorgaben sind in der API-Dokumentation ausgewiesen.
-   **Gibt es eine Testumgebung (Sandbox)?**\
    Nein, aktuell steht keine separate Testumgebung zur Verfügung.
-   **Wie wird über Änderungen informiert (Versionierung)?**\
    Breaking Changes werden mit einer neuen Version rückwärts-kompatibel veröffentlicht. Laufende Anpassungen und Updates werden direkt in der API-Dokumentation und im Changelog festgehalten.
-   **Wie ist der Datenschutz geregelt (DSG)?**\
    Der Datenzugriff erfolgt stets verschlüsselt und konform mit den Schweizer Datenschutzbestimmungen. Die Weiterverarbeitung der Daten in anderen Systemen unterliegt Ihrer Verantwortung. Wir weisen jedoch darauf hin, dass die Verarbeitung mit Services wie AI-Chatbots oft nicht den Datenschutzgesetzen entspricht.

Alles zum MCP Server finden Sie [hier](/fairwalter-mcp/)