Appearance

Zugang & Token ​

Überblick ​

Für die API brauchen Sie einen persönlichen Token (Personal Access Token). Sie erstellen ihn selbst im Cockpit.

Token erstellen ​

  1. 🔐 Im Cockpit anmelden: https://cockpit.beammycar.com/
  2. ⚙️ Oben rechts „Einstellungen“ öffnen und links API-Zugang wählen
  3. ➕ „Neuen Token erstellen“ klicken
  4. ✏️ Namen vergeben, z. B. „Auftragserfassung“
  5. ✅ Rechte wählen:
    • Lesen: Aufträge, Adressen, Kunden und Fahrer abrufen
    • Schreiben: Aufträge anlegen, ändern, stornieren, Fahrer zuweisen
  6. 📅 Gültigkeit wählen: 30, 90 (Standard) oder 365 Tage
  7. 📋 „Erstellen“ – der Token wird nur jetzt angezeigt. Kopieren und sicher ablegen.
  8. 🧪 Mit dem angezeigten curl- oder Python-Beispiel direkt testen

Token benutzen ​

Jede Anfrage trägt den Token im Header:

http
Authorization: Bearer bmc_pat_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
python
import requests

BASE = "https://cockpit.beammycar.com/api/external/v1"
HEADERS = {"Authorization": "Bearer bmc_pat_..."}

response = requests.get(f"{BASE}/addresses", params={"search": "Autohaus"}, headers=HEADERS)
print(response.status_code, response.json())

Ablauf & Widerruf ​

  • ⏳ Ein Token läuft nach der gewählten Zeit ab. In der Liste sehen Sie „läuft in X Tagen ab“; ab 7 Tagen vorher ist der Hinweis rot.
  • 🔄 Verlängern gibt es nicht: Erstellen Sie rechtzeitig einen neuen Token und tauschen Sie ihn in Ihrem System aus.
  • 🗑️ „Widerrufen“ sperrt einen Token sofort (spätestens nach einer Minute).
  • 👤 Wird Ihr Benutzer deaktiviert oder ändert sich Ihre Rolle, gilt das auch für Ihre Tokens.

Sicherheit ​

  • 🔒 Behandeln Sie den Token wie ein Passwort. Nicht in E-Mails, Tickets oder Quellcode-Repositories ablegen.
  • 🕵️ Tokens beginnen mit bmc_pat_. So erkennen auch Secret-Scanner (z. B. von GitHub) einen versehentlich veröffentlichten Token.
  • 🧹 Nicht mehr benötigte Tokens widerrufen.
  • 🔑 Jeder sieht und verwaltet nur seine eigenen Tokens.

Siehe auch ​