API: Allgemeine Informationen
Die API von BuchhaltungsButler ermöglicht es anderen Systemen und Tools, Aktionen in BuchhaltungsButler auszuführen, Daten zu importieren oder abzurufen.
Hier geht es direkt zur API-Dokumentation.
Wie aktiviere ich die API?
Die API von BuchhaltungsButler aktivieren Sie in Ihrem BuchhaltungsButler-Account unter Firmendaten, im Reiter "API Zugang". Nachdem Sie die API aktiviert haben, finden Sie an der selben Stelle Ihren API Client, Ihr API Secret und Ihren API Key. Diese drei Werte benötigen Sie, um sich zu verifizieren und mit unserer API zu kommunizieren.
Bitte beachten Sie: Wenn Sie sich mit einem autorisierten Partnerprogramm, welches in BuchhaltungsButler gelistet ist, verknüpfen möchten, benötigen Sie keine API-Zugangsdaten. Sie müssen lediglich in den Einstellungen, unter "verbundene Anwendungen", den Partnerdienst auswählen und aktivieren. Dort wird Ihnen dann Ihr API Key angezeigt, den Sie beim Partnerdienst hinterlegen müssen.
Welche Möglichkeiten bietet Ihnen die API?
Sie finden eine detaillierte technische Beschreibung der API in unserer API-Dokumentation. API-Endpunkte stehen Ihnen unter anderem für folgende Aktionen zur Verfügung:
Receipts
Hochladen und Abholen von Belegen
Transactions
Erstellen und Abholen von Transaktionen, Zuweisung von Belegen zu Transaktionen
Invoices
Erstellen von Rechnungen
Postings
Hinzufügen von Buchungssätzen zu Transaktionen und Belegen sowie freie Buchungen
Settings
Hinzufügen von Debitoren-/Kreditorenkonten
API-Schnittstelle testen
Es gibt diverse Möglichkeiten, die API-Schnittstelle Ihres BuchhaltungsButler Accounts zu testen. Wir empfehlen, die grundsätzliche Funktionalität mit Hilfe des Programms “Postman” zu testen. Postman vereinfacht das Erstellen und Testen von API-Requests. Wir haben eine Postman Collection mit 6 Beispiel-Requests erstellt, die Sie sich hier herunterladen und anschliessend in Postman importieren können.
Für die Authentifizierung eines Requests benötigen Sie Ihren API-Client und Ihr API-Secret. Damit Sie diese Daten nur einmal eintragen müssen, fügen Sie diese Daten Ihrer Collection hinzu. Hierzu gehen Sie auf die drei Punkte Ihrer BuchhaltungsButler Collection in Postman und klicken dann auf “edit” (siehe Screenshot 1).
Wechseln Sie nun zu dem Reiter “Authorization”. Hier wählen Sie auf der linken Seite die Option “BasicAuth” aus der Dropdown-Liste aus. Auf der rechten Seite tragen Sie bitte unter “Username” den API-Client Ihres BuchhaltungsButler Accounts und unter “Password” Ihr API-Secret ein (siehe Screenshot 2).
Klicken Sie nun auf einen Request innerhalb der Collection und wählen Sie in der Bildschirmmitte den Reiter “Auth” aus. Hier sollten Sie die Option “Inherit auth from parent” aktiviert haben bzw. nun aktivieren (siehe Screenshot 3). Auf diese Weise werden die Authentifizierungsparameter bei allen Requests, die in dieser Collection gespeichert werden, automatisch gesetzt.
Wechseln Sie nun auf den Reiter “Headers” und fügen Sie in der Spalte “KEY” die Formulierung “Content-Type” ein. In der Spalte “VALUE” fügen Sie “application/json” ein (siehe Screenshot 4). Dies ist notwendig, um den Request an Ihren BuchhaltungsButler Account senden zu können.
Als nächstes wechseln Sie auf den Reiter “Body”. Hier wählen Sie aus der Dropdown-Liste die Darstellungsform “raw” und aus dem Dropdown direkt daneben “JSON” als Datenaustauschformat aus. Nun finden Sie sich vor einer Art Console wieder, in der Sie Ihren API-Key eingeben und die Parameter für die API-Request definieren (siehe Screenshot 5). Welche Parameter für welche Request verpflichtend bzw. optional sind, erfahren Sie in unserer API-Dokumentation.
Hilfe mit der API
Bitte haben Sie Verständnis, dass wir aufgrund der Vielzahl an Entwicklungsumgebungen und -sprachen keine individuellen API-Requests prüfen können.
Sofern Sie Probleme mit der Nutzung der API haben, möchten wir Sie anhalten, einen Test mit der durch uns zur Verfügung gestellten Collection nach obigem Schema in Postman vorzunehmen.
So kann in aller Regel ausgeschlossen werden, das ein grundsätzliches Problem mit der API vorliegt.