Appearance
Schnittstelle (API): Überblick
Überblick
Mit der API legen Ihre eigenen Systeme Aufträge direkt im Cockpit an – zum Beispiel aus Ihrer Auftragserfassung oder einem Skript. Aufträge lassen sich außerdem lesen, ändern, stornieren und einem Fahrer zuweisen.
Voraussetzungen
- 🧩 Paket Enterprise (auf Anfrage auch für einzelne Business-Kunden freischaltbar)
- 🔑 Ein persönlicher API-Token aus dem Cockpit, siehe Zugang & Token
Auf einen Blick
- 🌐 Basis-URL:
https://cockpit.beammycar.com/api/external/v1 - 🔐 Anmeldung: Header
Authorization: Bearer bmc_pat_… - 📄 Format: JSON (UTF-8), Feldnamen in camelCase
- ❗ Fehler:
application/problem+jsonmitextensions.errorCode, siehe Fehler & Limits - 📚 Vollständige Feldreferenz (OpenAPI): https://cockpit.beammycar.com/api/external/docs
Was die API kann
| Aktion | Methode & Pfad | Recht im Token |
|---|---|---|
| Auftrag anlegen | POST /orders | Schreiben |
| Auftrag lesen | GET /orders/{id} | Lesen |
| Auftrag ändern | PATCH /orders/{id} | Schreiben |
| Auftrag stornieren | POST /orders/{id}/cancel | Schreiben |
| Fahrer zuweisen | PUT /orders/{id}/driver | Schreiben |
| Gespeicherte Adressen suchen | GET /addresses?search=… | Lesen |
| Kunden suchen | GET /clients?search=… | Lesen |
| Fahrer auflisten | GET /drivers | Lesen |
Wichtig zu wissen
- 👤 Ein Token handelt immer als die Person, die es erstellt hat. Es darf genau das, was diese Person im Cockpit darf – mehr dazu unter Rechte je Rolle.
- 🔁 Mit
externalId(Ihrer eigenen Auftragsnummer) entstehen keine doppelten Aufträge, wenn Ihr System eine Anfrage wiederholt. - 🏠 Bekannte Adressen und Kunden werden am Namen erkannt; Telefon, Kontakt usw. kommen dann aus dem Cockpit, siehe Adressen & Kunden erkennen.