API Zugriff einrichten
Du hast bei Billbee die Möglichkeit, eine API-Schnittstelle zu nutzen, mit der du Zugriff auf fast alle Daten und Funktionen innerhalb deines Billbee-Accounts hast. Ein Beispiel für die Nutzung der API ist, wenn du ein selbst entwickeltes System an Billbee anbindest, welches die Erfassung von Wareneingängen in deinem Lager übernimmt und mit der API die Lagerbestände der bereits vorhandenen Artikel in Billbee aktualisiert. Billbee wiederum übermittelt die neuen Bestände dann an die angebundenen Shops und Marktplätze. Wie du den API-Zugriff einrichtest, findest du im folgenden Artikel.
In diesem Artikel
Schritt-für-Schritt Anleitung zur Einrichtung
Für die Nutzung der API sind grundsätzlich zwei Dinge erforderlich. Zum einen benötigst du einen API Key, der die konkrete Anwendung (unabhängig von dem/der Billbee Nutzer:in) identifiziert. Zum anderen benötigst du einen Nutzernamen und ein spezielles API-Passwort, welches dich als konkrete:n Händler:in identifiziert.
API‑Key beantragen
Als Entwickler:in einer Anwendung bekommst du von Billbee einen API-Key. Der API-Key gilt dabei für alle Billbee-Accounts, auf die diese Anbindung zugreifen soll. Deshalb bekommt nur der/die Entwickler:in der Schnittstelle einen API-Key. Den API-Key benötigen lediglich die Entwickler:innen einer Schnittstelle (Fulfillment-Anbieter, Buchhaltungstools, CRM-Systeme etc.). Den API Key können Entwickler:innen direkt bei uns anfordern über support@billbee.io.
Hinweis: Es gibt eine neue Preisstruktur in Hinblick auf die API-Nutzung. Die Nutzung der Billbee-API ist bis zu einer monatlichen Obergrenze von 100.000 API-Calls (Schwellwert) kostenfrei. Für jeden API-Call, welcher den Schwellwert überschreitet, fällt eine Gebühr in Höhe von 0,0005 EUR (pro Call) an.
Bei der Beantragung des API-Keys werden folgende Informationen benötigt:
- Wofür genau wird der API-Key benötigt?
- Name + Mailadresse des/der Entwickler:in
- Rechnungsanschrift (für einen Partnervertrag zur Nutzung der API)
- Ust. ID des Rechnungsempfängers
- Mailadresse für Gebührenrechnungen, welche aus der Nutzung der API hervorgehen
Rechnungen werden nur dann erstellt, wenn die Nutzung über 100.000 Calls pro Monat hinausgeht. Bis zu diesem Schwellwert bleibt grundsätzlich die Nutzung der API kostenfrei.
API-Zugriff aktivieren
Zusätzlich benötigt der/die Entwickler:in von dir als Billbee User:in ein API-Passwort. Dieses kannst du in deinem Billbee-Account selbst vergeben. Nur so ist der Zugriff auf die Daten eines Billbee-Accounts möglich.
Unter Einstellungen / Billbee API kannst du den API-Zugriff bei Billbee aktivieren. Im Reiter "Allgemeine Einstellungen" kannst du die Aktivierung vornehmen und das Passwort festlegen, welches für die Aufrufe verwendet werden soll. Achte bitte darauf, dass du ein starkes Passwort vergibst, welches mindestens 12 Zeichen lang ist und mindestens einen Groß- und einen Kleinbuchstaben, eine Zahl und ein Sonderzeichen (!@$%^&*+#) beinhaltet. Diese Passwortrichtlinie gilt auch für das Abändern von alten Passwörtern.
Beim Hauptaccount ist der Nutzername die Mailadresse, auf die dein Billbee-Account registriert ist. Soll der API-Zugriff von einem Mitarbeiter-Account erfolgen, nutzt du den Nutzernamen, welcher bei Anlage des Mitarbeiter-Accounts für diesen vergeben wurde.
Dein Billbee Login + dein vergebenes API-Passwort sind also der Login für die Billbee-API.
Wichtig: Das API-Passwort darf nicht ":" enthalten. Dieses Sonderzeichen führt zu Problemen und Fehlermeldungen in der Anbindung.
Neben dem Reiter "Allgemeine Einstellungen" findest du hier auch noch den Reiter "Rechnungserstellung". Hier kannst du festlegen, dass beim Zugriff über die Billbee-API Rechnungen erzeugt werden dürfen. Standardmäßig ist diese Einstellung nicht aktiviert, kann aber von dir jederzeit aktiviert oder deaktiviert werden.
Hast du alle notwendigen Einstellungen für die API vorgenommen, dann kannst du mit dem Hauptnutzer deines Billbee-Accounts oder einem Mitarbeiter-Account auf die API zugreifen.
Wichtig / Zu beachten
- Für die API gibt es keine Zugriffsbeschränkungen für Mitarbeiter-Accounts. Die Rechte des Mitarbeiters beziehen sich nur auf die Nutzung der App, nicht auf die Nutzung der API.
- Das Passwort wird einmalig für den Account festgelegt und ist sowohl für den Hauptaccount als auch für alle Mitarbeiter-Accounts gleich.
API-Dokumentation
Die aktuelle technische Dokumentation der Billbee-API-Schnittstelle kannst du hier einsehen.
SDKs zur einfachen Integration
Für .NET und PHP bieten wir jeweils ein SDK an. Hiermit gelingt die Integration in dein bestehendes Projekt ganz einfach.