API-Schlüssel

Überblick

Das API-Schlüssel-Modul bietet VillaTax-Benutzern eine kontrollierte Möglichkeit, auf die öffentliche API-Oberfläche zuzugreifen: Schlüssel erstellen, damit API-Anfragen authentifizieren, widerrufen wenn nicht mehr benötigt.

Das Modul befindet sich unter API-Schlüssel. Die API-Spezifikation ist unter API-Dokumentation verfügbar.

Was das Modul unterstützt

• Neuen Schlüssel erstellen: einen Zugriffsschlüssel generieren, der mit dem authentifizierten Konto verknüpft ist
• Vorhandene Schlüssel anzeigen: sehen, welche Schlüssel aktiv sind und wann sie zuletzt verwendet wurden
• Schlüssel widerrufen: dauerhaft deaktivieren wenn eine Integration eingestellt wird

API-Bereich und Eigentümerschaft

Die VillaTax-API ist benutzergebunden. Ein API-Schlüssel gewährt Zugriff auf alle Organisationen des authentifizierten Benutzers. Auf Organisationsebene kann als Filterparameter gefiltert werden, ein Schlüssel deckt jedoch den gesamten Account ab.

Warum API-Zugriff wichtig ist

• Berichtsautomatisierung: Daten in externe Reporting-Tools ziehen ohne manuellen Export
• Externe Buchhaltungssysteme: VillaTax-Datensätze in ein separates Buchhaltungsprodukt pushen
• Individuelle Dashboards: VillaTax-Daten mit anderen Datenquellen kombinieren
• Integration mit Verwaltungssystemen: VillaTax in umfassendere Workflows einbinden

Sicherheitshygiene

• Schlüssel werden nur bei der Erstellung angezeigt, danach nur noch Metadaten
• Bei Kompromittierung kann der Schlüssel sofort widerrufen werden ohne den Account-Login zu beeinträchtigen
• Für jede Integration einen separaten Schlüssel erstellen ist gute Praxis

Erste Schritte

Öffnen Sie API-Schlüssel wenn eine Integration programmatischen Zugriff benötigt. Schlüssel erstellen, bei Erstellung kopieren, im externen System konfigurieren. Widerrufen wenn nicht mehr aktiv. API-Spezifikation unter API-Dokumentation prüfen.