Bauen Sie Ihren eigenen Mietshop auf der Be-Bookable-API
Kurz gesagt
- Ihr Entwickler baut Ihren eigenen Webshop oder Buchungsablauf in Ihrem eigenen Design. Be-Bookable liefert die Produkte, die Verfügbarkeit, die Preise und den Checkout.
- Ihre eigenen Systeme lesen Ihre Bestellungen mit einem API-Token, und Webhooks melden, wenn eine Bestellung eingeht, bezahlt ist oder ihren Status ändert.
- Die API ist in jedem Be-Bookable-Tarif enthalten, ohne Aufpreis. Ihr Entwickler baut und testet in einer Sandbox mit Testzahlungen.
Warum auf der Be-Bookable-API bauen
Mit zwei Zeilen Code bringt das Website-Widget einen fertigen Mietshop auf Ihre Website. Manche Vermieter wollen mehr: einen Buchungsablauf im eigenen Design oder Bestellungen, die direkt in ihre eigenen Systeme gehen. Mit der API baut Ihr Entwickler genau das, und Be-Bookable übernimmt weiter den schwierigen Teil: Verfügbarkeit, Preise, Mehrwertsteuer, Kaution und Zahlung.
Wir rechnen, Sie gestalten
Verfügbarkeit, Preise, Mehrwertsteuer, Versand, Kaution und Zahlung kommen von Be-Bookable. Ihr Webshop zeigt nur das Ergebnis, es passt also immer zu Ihrem Bestand und Ihren Preisen.
Bestellungen in Ihren eigenen Systemen
Ein Skript, Zapier oder Make liest Ihre Bestellungen mit einem API-Token, mit Kundendaten. Webhooks senden eine signierte Nachricht, wenn eine Bestellung eingeht, bezahlt ist oder ihren Status ändert.
Sicher bauen und testen
Ihr Entwickler baut in einer Sandbox mit Testzahlungen, neben einem funktionierenden Beispielshop. Version 1 bekommt nur Neues dazu, Ihr Webshop funktioniert also weiter, wenn die API wächst.
So bauen Sie Ihren eigenen Shop auf der API
- Schalten Sie den API-Zugriff ein. Gehen Sie in der Be-Bookable-App zu Integrationen und öffnen Sie die Karte API-Zugriff. Fügen Sie die Domain Ihres eigenen Shops hinzu, zum Beispiel
shop.example.com, und die Rücksprung-URL nach der Zahlung. Schalten Sie ihn danach ein. - Bauen Sie in der Sandbox. Ihr Entwickler beginnt mit der Anleitung Build your own shop, zu der ein funktionierender Beispielshop gehört. Die Sandbox unter
https://test.api.be-bookable.com/v1akzeptiert Testzahlungen und hat einen Testshop, so lässt sich jeder Schritt ohne echte Bestellungen ausprobieren. - Lassen Sie Be-Bookable die Buchung erledigen. Ihr Webshop zeigt den Katalog, prüft die Verfügbarkeit und fragt Be-Bookable nach dem Gesamtbetrag. Danach legt er die Bestellung an und schickt den Kunden zur Zahlungsseite. Nach der Zahlung landet der Kunde auf Ihrer Rücksprung-URL.
- Verbinden Sie Ihre eigenen Systeme. Öffnen Sie die Karte Bestellungen-API & Webhooks. Erstellen Sie ein API-Token für jedes Programm und fügen Sie die URL Ihres Webhooks hinzu. Testnachricht senden zeigt sofort, ob Ihr Server die Nachricht erhält. Nur der Inhaber des Shops kann das.
- Gehen Sie live. Registrieren Sie die Domain Ihres Live-Shops, ändern Sie die Basis-URL in
https://api.be-bookable.com/v1und geben Sie eine echte Bestellung über den ganzen Ablauf auf.
Was die API abdeckt
Die Anfragen in der Reihenfolge, in der ein Kunde sie nutzt:
Die ID des Shops, seine Farben, das Logo, das Land, die Zeitzone, die Versandoptionen und die Schließtage
GET /partners/{slug}Die Kategorien und Produkte Ihres Shops, mit Bildern, Preisen, Varianten und Bestellgrenzen
GET /partners/{id}/categoriesGET /categories/{id}/productsGET /products/{id}Die Öffnungszeiten sowie die AGB oder die Datenschutzerklärung für den Checkout
GET /opening-hours/{id}GET /partners/{id}/pages/{type}Die freien Produkte in einem Zeitraum, ein Kalender oder Zeitfenster für ein Produkt oder die Prüfung eines Zeitraums und einer Menge
GET /available-productsGET /check-availability-for-periodGET /check-availabilityDer Gesamtbetrag mit Mehrwertsteuer, Versand, Kaution und Rabatten
POST /calculate-totalDie Zahlungsarten des Shops, danach die Bestellung und ein Link zur Zahlungsseite
GET /payment-methods/{id}POST /create-orderDie Bestellnummer und der Zahlungsstatus für Ihre Dankeseite
GET /order/{orderId}Ihre Bestellungen mit Kundendaten, mit einem API-Token
GET /ordersGET /orders/{orderId}Zugriff, Limits und Webhooks
- Shop: kein Token. Ihr Shop sendet seine Anfragen aus dem Browser, auf den Domains, die Sie registriert haben. Die Bestellung, die Ihr Shop zurückliest, enthält keine personenbezogenen Daten Ihrer Kunden.
- Bestellungen-API: ein API-Token im Header
Authorization, nur von Ihrem Server. Es liest dieselben Bestellungen wie in der Auftragsverwaltung, mit Kundendaten. Ein Shop kann 10 Tokens haben, und Sie widerrufen jedes Token einzeln. - Webhooks: drei Ereignisse, signiert mit HMAC-SHA256:
order.created,order.paid,order.status_changed. Antwortet Ihr Server nicht, versuchen wir es nach 1 Minute, 5 Minuten, 30 Minuten, 2 Stunden und 12 Stunden erneut. Das Zustellprotokoll bewahrt jede Nachricht 30 Tage auf. - Limits: 120 Lese- und 10 Schreibzugriffe pro Minute je IP-Adresse und 600 Anfragen pro Minute je Token. Eine Antwort 429 nennt in Retry-After, wann Sie es erneut versuchen können.
- Versionen: Version 1 bekommt nur Neues dazu, etwa neue Felder oder Endpunkte. Jede Änderung steht im API-Changelog.
So sieht es aus
Eine echte Anfrage aus der Anleitung: Ihr Shop fragt den Gesamtbetrag eines Warenkorbs ab, und Be-Bookable berechnet ihn. Danach die Nachricht, die Ihr Server erhält, wenn eine Bestellung bezahlt ist.
Häufig gestellte Fragen
Kostet die API extra?
Nein. Die API ist in jedem Be-Bookable-Tarif enthalten, siehe Preise. Sie bezahlen nur Ihren eigenen Entwickler oder Ihre Agentur für die Arbeit an Ihrem Shop.
Brauche ich einen Entwickler?
Ja. Die API ist für jemanden, der Code schreibt, etwa Ihren eigenen Entwickler oder eine Webagentur. Möchten Sie ohne Code einen Mietshop auf Ihrer Website? Dann nutzen Sie das Website-Widget.
Was ist der Unterschied zum Website-Widget?
Das Website-Widget ist ein fertiger Mietshop, den Sie mit zwei Zeilen Code auf Ihre Website setzen. Mit der API baut Ihr Entwickler den Shop selbst, Design und Buchungsablauf gehören also ganz Ihnen. Hinter beiden stehen dieselben Produkte, Verfügbarkeiten, Preise und Bestellungen in Be-Bookable.
Was ist der Unterschied zum KI-Assistenten?
Der KI-Assistent ist für Sie: Sie fragen Claude oder ChatGPT nach Ihrem Shop und lassen ihn Preise, Bestand oder Öffnungszeiten ändern, ohne Code. Die API ist für die Software, die Ihr Entwickler baut: einen Shop für Ihre Kunden und Anbindungen an Ihre eigenen Systeme.
Können wir ohne echte Bestellungen testen?
Ja. Die Sandbox unter https://test.api.be-bookable.com/v1 akzeptiert Testzahlungen, und der Beispielshop zeigt dort eine vollständige Bestellung. Für Webhooks sendet Testnachricht senden in der App eine Testnachricht an Ihren Server, signiert mit Ihrem echten Secret.
Welche Webhooks gibt es?
Drei: order.created, wenn eine Bestellung eingeht, order.paid, wenn die Zahlung bestätigt ist, und order.status_changed, wenn sich der Status einer Bestellung ändert. Jede Nachricht ist signiert, damit Ihr Server prüfen kann, dass sie von Be-Bookable kommt. Auch Zapier und Make können sie empfangen.
Gibt es Limits?
Ja. Pro IP-Adresse: 120 Lese- und 10 Schreibzugriffe pro Minute, mit höchstens 10 Bestellungen pro Minute. Pro API-Token: 600 Anfragen pro Minute. Die Header jeder Antwort zeigen, wie viele Anfragen noch übrig sind.
Kann mein Entwickler die Daten meiner Kunden sehen?
Nur mit einem API-Token. Die Anfragen Ihres Shops geben nie die personenbezogenen Daten Ihrer Kunden heraus. Ein API-Token liest Ihre Bestellungen mit Kundendaten, und nur der Inhaber des Shops kann eines erstellen. Ein Token, das Sie widerrufen, funktioniert sofort nicht mehr.
Wo ist die Dokumentation?
Alles finden Sie auf developers.be-bookable.com: die Anleitung Build your own shop, die vollständige Referenz jeder Anfrage, der Beispielshop und das Changelog.
