Einrichtung der API-Schnittstelle

API aktivieren
Um die API in Ihrem BuhaPortal Account zu aktivieren, gehen Sie zu “Einstellungen” → “Schnittstellen und API-Zugang”. Nach der Aktivierung finden Sie an derselben Stelle Ihren API-Client, Ihr API-Secret und Ihren API-Key. Diese drei Werte benötigen Sie, um sich zu authentifizieren und mit unserer API zu kommunizieren.

Wichtiger Hinweis: Möchten Sie sich mit einem autorisierten Partnerprogramm, das in BuhaPortal gelistet ist, verbinden, sind keine API-Zugangsdaten erforderlich. In diesem Fall müssen Sie lediglich in den “Einstellungen” → “Schnittstellen und API-Zugang” den Partnerdienst auswählen und aktivieren. Der API-Key wird Ihnen dort angezeigt und muss beim Partnerdienst hinterlegt werden.

Die Anbindung an unseren Partnerdienst GetMyInvoices erfolgt im Bereich “Einstellungen” → “Belegübertragung” unter “Belegübertragung mit GetMyInvoices”.

Möglichkeiten der API-Nutzung
Eine detaillierte technische Beschreibung der API finden Sie in unserer API-Dokumentation. Die API-Endpunkte stehen Ihnen unter anderem für folgende Funktionen zur Verfügung:

– Receipts: Hochladen und Abrufen von Belegen und Beleginformationen.
– **Transactions**: Erstellen und Abrufen von Zahlungen sowie die Zuweisung von Belegen zu Zahlungen.
– Invoices: Erstellen von Rechnungen, Angeboten und Gutschriften, auch als Entwurf.
– Postings: Hinzufügen und Abrufen von Buchungssätzen.
– Settings: Hinzufügen von Debitoren- und Kreditorenkonten.
– Accounts: Abfragen der vorhandenen Basiskonten.
– **Comments**: Übergabe von Kommentaren zu Belegen oder Zahlungen.

API-Schnittstelle testen
Es gibt verschiedene Möglichkeiten, die API-Schnittstelle Ihres BuhaPortal Accounts zu testen. Wir empfehlen, die grundlegende Funktionalität mit dem Programm “Postman” zu testen. Postman erleichtert das Erstellen und Testen von API-Requests. Wir haben eine Postman Collection mit sechs Beispiel-Requests erstellt, die Sie herunterladen und in Postman importieren können.

Für die Authentifizierung eines Requests benötigen Sie Ihren API-Client und Ihr API-Secret. Um diese Daten nur einmal einzugeben, fügen Sie sie Ihrer Collection hinzu. Gehen Sie dazu auf die drei Punkte Ihrer BuhaPortal Collection in Postman.

Wechseln Sie zum Reiter “Authorization” und wählen Sie “BasicAuth” aus der Dropdown-Liste. Tragen Sie unter “Username” den API-Client Ihres BuhaPortal Accounts und unter “Password” Ihr API-Secret ein.

Klicken Sie nun auf einen Request in der Collection und wählen Sie den Reiter “Auth”. Aktivieren Sie die Option “Inherit auth from parent” (siehe Screenshot 3), damit die Authentifizierungsparameter für alle Requests in dieser Collection automatisch übernommen werden.

Wechseln Sie zum Reiter “Headers” und fügen Sie unter “KEY” den Eintrag “Content-Type” und unter “VALUE” “application/json” ein. Dies ist notwendig, um den Request an Ihren BuhaPortal Account senden zu können.

Gehen Sie dann zum Reiter “Body”, wählen Sie im Dropdown “raw” und im Dropdown daneben “JSON” als Datenaustauschformat. Jetzt können Sie die API-Parameter eingeben und definieren. Welche Parameter für welchen Request verpflichtend oder optional sind, entnehmen Sie bitte 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. Falls Sie Probleme bei der Nutzung der API haben, empfehlen wir Ihnen, einen Test mit der von uns bereitgestellten Collection in Postman durchzuführen. So kann in der Regel ausgeschlossen werden, dass ein grundlegendes Problem mit der API vorliegt.