Direkt zum Hauptinhalt

Einführung in die BrickOwl API

Kurz erklärt

Über die BrickOwl API können Programme auf Shopdaten zugreifen. Gedacht ist sie vor allem für Bestellungen, Inventar und die Synchronisierung mit anderen Systemen.

So bekommst du Zugang

Mit einem BrickOwl-Konto kannst du einen API-Schlüssel mit den benötigten Rechten anlegen. Gib einem Werkzeug nur die Rechte, die es wirklich braucht.

Anfragen

Bei GET-Anfragen werden Schlüssel und Parameter als URL-Parameter übertragen. Bei POST-Anfragen verlangt die offizielle Dokumentation die Parameter im Request-Body mit dem Inhaltstyp:

application/x-www-form-urlencoded

Wichtige Bereiche

  • Store Inventory – Shop-Inventar
  • Order – Bestellungen
  • Invoice – Rechnungs- und Zahlungsvorgänge
  • Store Coupon – Gutscheine
  • User – Benutzerinformationen
  • Webhook – Benachrichtigungen
  • Catalog – Katalogzugriffe mit besonderen Bedingungen

Wie viele Anfragen erlaubt sind

BrickOwl nennt für die meisten Anfragen ein Limit von 600 Anfragen pro Minute. Zusätzlich gelten getrennte tägliche Kontingente pro Benutzer. Einzelne Methoden können abweichende Grenzen besitzen.

Ein paar wichtige Spielregeln

Die API-Dokumentation verlangt unter anderem:

  • einen eindeutigen User-Agent für das jeweilige Werkzeug
  • Schutz personenbezogener Daten nach DSGVO
  • keine längere Speicherung personenbezogener Daten als erforderlich
  • Quellenangabe mit Link bei angezeigten Katalog- und Preisdaten
  • Beachtung, dass keine Lizenz zur Nutzung der BrickOwl-Bilder erteilt wird

Schütze deinen Schlüssel

API-Schlüssel dürfen nicht veröffentlicht oder in gemeinsam genutzte Beispieldateien kopiert werden. Anwendungen sollten nur die unbedingt benötigten Berechtigungen erhalten.

Quellen