Bevor du deine Integration in Betrieb nimmst, solltest du sie gründlich testen – mit den richtigen Tools geht das schnell und ohne Risiko.
Welches Tool für welchen Zweck?
Je nachdem, was du testen möchtest, gibt es unterschiedliche Werkzeuge. Hier ein Überblick:
| Tool | Typ | Ideal für | Kosten |
|---|---|---|---|
| Browser | Immer verfügbar | Schnelle GET-Abfragen ohne Installation | kostenlos |
| curl | Kommandozeile | Alle Methoden, Scripting, Automatisierung | kostenlos |
| Postman | Desktop-App / Web | Komfortables Testen, Sammlungen, Teams | kostenlos (Basis) |
| Insomnia | Desktop-App | Schlanke Postman-Alternative | kostenlos (Basis) |
| webhook.site | Webseite | Webhook-Empfang testen ohne eigenen Server | kostenlos |
Methode 1: Browser – für schnelle GET-Tests
Für lesende Anfragen (GET) reicht ein normaler Browser völlig aus. Einfach die URL mit API-Schlüssel direkt in die Adressleiste eingeben:
https://{deineBillomatID}.billomat.net/api/clients?api_key={dein-api-schluessel}&format=json
Der Browser zeigt die JSON- oder XML-Antwort direkt an. Für JSON empfiehlt sich ein Browser-Plugin wie JSON Formatter (Chrome) oder JSONView (Firefox) – damit wird die Antwort übersichtlich eingefärbt und eingerückt dargestellt.
Hinweis: Den API-Schlüssel per GET-Parameter im Browser zu verwenden ist praktisch für kurze Tests – aber nicht für den produktiven Einsatz geeignet, da er in der Browser-History gespeichert wird. Mehr dazu im Artikel Sicherheit & HTTPS.
Methode 2: curl – für alle Methoden
curl ist ein Kommandozeilen-Tool, das auf macOS, Linux und Windows (ab Version 10) vorinstalliert ist. Es unterstützt alle HTTP-Methoden und ist ideal für schnelle Tests direkt im Terminal.
Verfügbarkeit prüfen:
curl --version
Alle Kunden abrufen (GET):
curl -H 'X-BillomatApiKey: {dein-api-schluessel}' \https://{deineBillomatID}.billomat.net/api/clients?format=json
Neuen Kunden anlegen (POST):
curl -X POST \-H 'X-BillomatApiKey: {dein-api-schluessel}' \-H 'Content-Type: application/json' \-d '{"client":{"name":"Testfirma GmbH"}}' \https://{deineBillomatID}.billomat.net/api/clients
Response-Header anzeigen lassen (nützlich für Rate Limit):
curl -v -H 'X-BillomatApiKey: {dein-api-schluessel}' \https://{deineBillomatID}.billomat.net/api/clients
Tipp: Mit dem Flag -v (verbose) zeigt curl die vollständigen Request- und Response-Header an – sehr hilfreich, um z.B. X-Rate-Limit-Remaining oder Fehlermeldungen zu sehen.
Methode 3: Postman – komfortabel und visuell
Postman ist die beliebteste grafische Oberfläche für API-Tests. Du klickst zusammen, was du abfragen möchtest – kein Tippen von curl-Befehlen nötig.
- Postman herunterladen und installieren unter postman.com – kostenloser Account reicht vollständig aus.
- Neue Anfrage erstellen: Oben auf + klicken.
- Methode wählen: GET, POST, PUT oder DELETE im Dropdown links neben der URL-Leiste auswählen.
-
URL eingeben: z.B.
https://{deineBillomatID}.billomat.net/api/clients -
API-Schlüssel eintragen: Reiter Headers öffnen und zwei Zeilen ausfüllen:
X-BillomatApiKey→{dein-api-schluessel}Accept→application/json - Bei POST/PUT – Body befüllen: Reiter Body → raw → JSON auswählen und die Daten eingeben.
- Senden: Auf den blauen Send-Button klicken – die Antwort erscheint im unteren Bereich mit Statuscode, Body und Headers.
Tipp: In Postman kannst du Anfragen in Collections speichern und wiederverwenden. Lege z.B. eine Collection „Billomat API" an und speichere alle deine Test-Anfragen darin – so musst du Headers und URLs nicht jedes Mal neu eingeben.
Entwickler-Account nutzen
Um deine Integration risikofrei zu entwickeln und zu testen, ohne Produktivdaten zu berühren, empfehlen wir die Nutzung eines kostenlosen Entwickler-Accounts.
Schreib uns einfach an api@billomat.com – wir richten dir einen separaten Test-Account ein, auf dem du alle API-Funktionen vollständig ausprobieren kannst.
Empfehlung: Entwickle und teste immer zuerst auf dem Entwickler-Account – erst wenn alles wie gewünscht funktioniert, schaltest du die Integration auf den Produktiv-Account um. So vermeidest du versehentlich erstellte oder gelöschte Datensätze in echten Kundendaten.
Webhooks testen mit webhook.site
Zum Testen von Webhooks brauchst du normalerweise einen öffentlich erreichbaren Server. Mit webhook.site geht das ohne eigene Infrastruktur – in unter einer Minute:
- webhook.site öffnen: webhook.site aufrufen – du bekommst sofort eine einmalige Test-URL.
- URL kopieren und in Billomat als Webhook-Ziel-URL eintragen (Einstellungen > Administration > Webhooks).
- Ereignis auslösen: z.B. eine Rechnung erstellen.
- Auf webhook.site nachschauen: Die Nachricht von Billomat erscheint sofort – mit allen Headers und dem vollständigen Body.
Mehr zu Webhooks im Artikel Billomat Webhooks.
Checkliste vor dem Produktivstart
Bevor du deine Integration live schaltest, solltest du folgende Punkte abhaken:
- ✅ Alle Requests laufen über HTTPS
- ✅ API-Schlüssel wird per Header übergeben, nicht per GET-Parameter
- ✅ API-Schlüssel ist nicht im Quellcode hart hinterlegt
- ✅ Fehlerbehandlung ist implementiert – alle relevanten Statuscodes werden abgefangen
- ✅ Rate-Limit-Header werden ausgewertet und die Anwendung drosselt sich bei Bedarf
- ✅ Alle Tests wurden auf dem Entwickler-Account durchgeführt
- ✅ App ist registriert, falls ein höheres Kontingent benötigt wird
Wie geht es weiter?
Du hast jetzt alle Grundlagen der Billomat API kennen gelernt. In den nächsten Abschnitten findest du die detaillierten Referenzen für alle Ressourcen:
- Webhooks – ereignisgesteuerte Benachrichtigungen einrichten
- Stammdaten-Ressourcen – Kunden, Lieferanten, Artikel
- Dokumente-Ressourcen – Rechnungen, Angebote, Mahnungen und mehr
Kommentare
0 Kommentare
Zu diesem Beitrag können keine Kommentare hinterlassen werden.