Wie binde ich die Craftboxx per REST-API oder Webhook an?

Verbinde dein ERP-System oder Buchhaltungstool über die kostenlose REST-API oder Webhooks mit der Craftboxx. Du kannst damit Daten in der Craftboxx ändern, importieren oder exportieren.

Was ist die REST-API?

Die REST-API ist eine webbasierte Schnittstelle der Cloudsoftware. Du kannst damit sämtliche Informationen in der Craftboxx ändern, importieren oder exportieren.

Du kannst folgende Daten ändern:

• Kundendaten (Adressen, Namen etc.)
• Aufträge und Termine
• Mitarbeiter/in
• Zugänge, Rollen und Lizenzen
• Abwesenheiten
• Artikel / Materialien
• Dokumente (z. B. PDFs)
• Fotos, Zeiteinträge etc. von der Baustelle
• Stundenzettel / Lohnzeiten
• Ressourcen, wie Werkzeuge oder Fahrzeuge

Was ist der Webhook?

Ein Webhook benachrichtigt ein anderes System über Änderungen in der Craftboxx (z. B. Status auf "fertig" gesetzt). Dadurch löst die andere Software ein Ereignis aus (z. B. Rechnungserstellung).

Für wen eignen sich REST-API oder Webhooks?

Die Schnittstellen sind für Firmen geeignet, die ihr ERP- oder Buchhaltungstool individuell an die Craftboxx anschließen wollen. Die Anbindung ist kostenlos, setzt jedoch IT-Kenntnisse voraus. Beispiele für bereits angeschlossene Systeme sind SAP, Microsoft Navision oder intern entwickelte ERPs.

Wie funktioniert es?

Die REST-API ist komplett dokumentiert. Du kannst die Dokumentation über diesen Link einsehen: https://api.craftboxx.de/.

Häufige Fragen zur Craftboxx REST-API (FAQ)

Wie bekomme ich Zugangsdaten (API-Token) zur REST-API?

1. Im Adminbereich anmelden: Melde dich in der Craftboxx Webversion mit einem Admin-Zugang an.
2. Zu den Einstellungen wechseln: Klicke oben rechts auf Adminbereich -> Schnittstellen.
3. API Dokumentation öffnen: Klicke bei API auf den Button "Selber bauen" und die Dokumentation öffnet sich. 
4. Unter "Authentication" Schritte folgen:
   Token abrufen: Sende eine POST-Anfrage mit deinen Mitarbeiter-Anmeldedaten (E-Mail-Adresse und Passwort) an den Endpunkt: /auth/create-token.
   
   Anfragen autorisieren: Füge das erhaltene Token bei jedem nachfolgenden API-Aufruf in den Authorization-Header ein. Der Header sollte wie folgt formatiert sein: Authorization: Bearer <YOUR_ACCESS_TOKEN>
   
   Dein API-Zugriff unterliegt denselben Berechtigungen, die du im Craftboxx Planner hast.
   Wenn dein Token ungültig oder abgelaufen ist, gibt die API den Statuscode 401 Unauthorized zurück.
   
   

Welche Daten kann ich mit der REST-API lesen oder schreiben?

Über die REST-API kannst du u. a. folgende Daten automatisiert verarbeiten:

• Kunden- und Adressdaten
• Aufträge und Termine
• Mitarbeitende und Zugänge
• Abwesenheiten
• Artikel / Materialien
• Dokumente (z. B. PDFs), Fotos und Zeiteinträge von der Baustelle
• Stundenzettel / Lohnzeiten
• Ressourcen (Fahrzeuge, Werkzeuge, Geräte)

💡 HINWEIS: Welche konkreten Endpunkte zur Verfügung stehen und welche Felder jeweils unterstützt werden, findest du in der technischen API-Dokumentation (z. B. für deine Entwickler:innen). Diese Dokumentation sollte immer als Referenz für Implementierungen genutzt werden.

REST-API oder Webhook – was ist wofür besser geeignet?

• REST-API nutzen, wenn du …

  • Daten aktiv aus einem externen System in die Craftboxx schreiben möchtest (z. B. Kunden, Aufträge, Termine).
  • Daten regelmäßig aus der Craftboxx abfragen willst (z. B. für ein Reporting oder Data Warehouse).

• Webhooks nutzen, wenn du …

  • andere Systeme „live“ informieren willst, sobald sich in der Craftboxx etwas ändert (z. B. Auftragsstatus „fertig“, neuer Zeiteintrag, neuer Auftrag).
  • in anderen Systemen automatisch Aktionen auslösen möchtest (z. B. Rechnung erstellen, Ticket anlegen), sobald ein Ereignis in der Craftboxx passiert.

Was sollte ich vor dem Start mit der API klären?

1. Ziel definieren:
   • Was soll automatisiert werden (z. B. Kundenimport, Auftragsanlage, Status-Rückmeldung)?
2. Richtung der Daten:
   • Sollen Daten nur in die Craftboxx, nur aus der Craftboxx oder in beide Richtungen laufen?
3. Verantwortliche Person / Dienstleister:
   • Wer setzt die technische Anbindung um (interne IT, externer Dienstleister, Softwareanbieter)?
4. Testumgebung:
   • Wenn möglich, zunächst mit Testdaten oder in einer Testumgebung starten, um falsche oder doppelte Einträge zu vermeiden.

💡 HINWEIS: Eine fehlerhafte API-Implementierung kann zu doppelten Datensätzen, falschen Status oder unvollständigen Auftragsdaten führen. Lass die Anbindung deshalb immer von technisch versierten Personen (Developer, IT, Anbieter des anderen Systems) durchführen und prüfe die Ergebnisse zu Beginn stichprobenartig.