Zum Inhalt springen

Lösungen

Freelancer & Selbstständige Rechnungen und Belege ohne Shop eBay Verkäufe automatisch abrechnen Shopify Bestellungen direkt aus dem Shop WooCommerce WordPress-Shop anbinden

API-Zugang einrichten und den ersten Abruf testen

Stand: 2 Min. Lesezeit

Du willst Aufträge, Kunden oder Artikel aus einem eigenen Programm heraus abrufen oder anlegen? Dafür gibt es die billware-API. In billware brauchst du dazu das Zusatzmodul REST-API und deine beiden Zugangsdaten, alles Weitere steht in der API-Dokumentation. Den Zugang richtest du in ein paar Minuten ein, das Programmieren übernimmt danach jemand, der sich damit auskennt.

API-Zugang einrichten: Zusatzmodul buchen

  1. Öffne „Mein Konto › Zusatzmodule“ und such die REST-API.
  2. Klicke auf „Kostenlos Testen“, wenn du noch in der Testphase bist, sonst auf „Buchen“, und bestätige im Fenster.
  3. Danach findest du im Menü „Apps“ den Eintrag „API“.

API-Appid und API-Secret finden

Auf der Seite „Apps › API“ liegen deine Zugangsdaten. Sie sind verdeckt, bis du sie brauchst.

  1. Öffne „Apps › API“.
  2. Klicke im Bereich „API Authentifizierung“ auf „API-Anmeldedaten anzeigen“.
  3. Kopiere „API-Appid“ und „API-Secret“ in dein Programm.
Seite Apps API mit dem Bereich API Authentifizierung
Die Zugangsdaten sind verdeckt, bis du sie anzeigen lässt.

Achtung: Mit diesen Daten kommt man an deine Aufträge, Kunden und Artikel. Gib sie nicht weiter, schick sie nicht per E-Mail und leg sie nicht in öffentlichen Code. Gehört dein Programm jemand anderem, soll er sie nur dort hinterlegen, wo sie niemand mitlesn kann. Sind sie doch einmal in falsche Hände geraten, erzeugst du sie auf derselben Seite über „API-Anmeldedaten neu generieren“ neu — danach musst du sie in deinem Programm austauschen.

Den ersten Abruf testen

Die API nimmt Anfragen per POST entgegen. Mitgeschickt werden immer:

Angabe Inhalt
X-Bw-Method Name der Methode, zum Beispiel test.connection oder order.create
X-Bw-Hmac deine API-Appid, ein Doppelpunkt und die berechnete Signatur
Content-Type application/json

Für den ersten Versuch eignet sich die Methode test.connection: Sie verändert nichts und sagt dir nur, ob die Zugangsdaten und die Signatur stimmen. Wie die Signatur berechnet wird und welche Methoden es gibt, steht mit Beispielen in der API-Dokumentation.

Aufrufe im Blick behalten

Unter „API-Calls der letzten Stunde“ steht jeder Aufruf mit „Uhrzeit“, „Methode“, „Status Code“, „Nachricht“ und „IP Adresse“. Das hilft beim Einrichten: Kommt nichts an, liegt es meisst an der Signatur oder an einem Tippfehler im Methodennamen.

Leere Tabelle der API-Calls der letzten Stunde mit den Spalten Uhrzeit, Methode, Status Code, Nachricht und IP Adresse
Vor dem ersten Aufruf ist die Tabelle leer, danach steht hier jede Anfrage.

Wie viele Aufrufe pro Stunde möglich sind, steht daneben unter „Dein gebuchtes Paket“.

API und Webhooks zusammen nutzen

Die API ist der Weg von deinem Programm zu billware. Umgekehrt meldet sich ein Webhook bei dir, sobald sich in billware etwas ändert, zum Beispiel wenn ein Auftrag entsteht. Das spart Abfragen auf Verdacht: Der Webhook meldet die Änderung, über die API holst du die Einzelheiten. Wie du Webhooks einrichtest und die Signatur prüfst, steht in Webhooks einrichten.

Häufige Fragen

Wo finde ich API-Appid und API-Secret?
Unter „Apps › API“ über den Knopf „API-Anmeldedaten anzeigen“. Sie sind absichtlich verdeckt, damit sie nicht in Screenshots oder auf geteilten Bildschirmen landen.
Wie viele Aufrufe darf ich machen?
Das hängt von deinem gebuchten Paket ab. Auf derselben Seite siehst du unter „Dein gebuchtes Paket“, wie viele Aufrufe pro Stunde möglich sind.
Wie sehe ich, ob meine Aufrufe ankommen?
Die Tabelle „API-Calls der letzten Stunde“ zeigt Uhrzeit, Methode, Status Code, Nachricht und IP-Adresse. Dort siehst du auch, warum ein Aufruf abgelehnt wurde.
Was ist der Unterschied zu Webhooks?
Mit der API holst du Daten aktiv ab oder legst welche an. Ein Webhook meldet sich von selbst, sobald sich in billware etwas ändert. Beides lässt sich gut kombinieren.
Brauche ich dafür ein Zusatzmodul?
Ja, die REST-API. Welche Zusatzmodule es gibt, siehst du auf der Seite Preise.

Stimmt etwas nicht mehr mit billware überein?