Zum Inhalt springen
craftdexDocs

Überblick

Die Export-Schnittstelle api.craftdex.de – alle Daten eines Betriebs mit einem API-Schlüssel abrufen, nur lesend.

Über https://api.craftdex.de/v1 holen Programme den Komplett-Export eines Betriebs ab: ein neuer Anbieter beim Wechsel, der Steuerberater oder eine eigene Sicherung. Der Betrieb erstellt dafür einen API-Schlüssel und gibt ihn weiter. Die Schnittstelle ist kostenlos und kann nur lesen, sie ändert und löscht nichts.

Endpunkte

EndpunktLiefert
GET /v1/infoBetrieb, Formatversion, Schlüssel, letzter vollständiger Export, Anzahl und Größe der Dateien
GET /v1/exportKomplett-Export als ZIP-Datei
GET /v1/export.jsonalle Tabellen und das Verzeichnis der Dateien als JSON, ohne Dateiinhalte
GET /v1/files/{ablage}/{pfad}eine einzelne Datei im Original, mit Prüfsumme im Kopf

Einzelheiten: Endpunkte. Für Werkzeuge, die OpenAPI lesen: openapi.yaml.

Welcher Weg passt

  • Kleiner Betrieb, ein Abruf: GET /v1/export. Die ZIP-Datei hat denselben Aufbau wie der Export in der Anwendung, nur ohne stammdaten.xlsx.
  • Viele Fotos und Dokumente: erst GET /v1/export.json, dann jede Datei einzeln über files. Bricht eine Verbindung ab, wiederholen Sie nur diese eine Datei. Ein Beispielskript zeigt den Ablauf.

Grundsätze

  • Anmeldung nur mit API-Schlüssel im Kopf Authorization: Bearer cdx_…
  • Antworten tragen X-Craftdex-Format-Version: 1 und Cache-Control: no-store
  • Fehler kommen als JSON mit Code und Text, siehe Fehler und Grenzen
  • Version 1 bleibt stabil. Eine Änderung, die bestehende Programme stören würde, bekäme /v2/, und /v1/ liefe mindestens 6 Monate weiter. Neue Tabellen oder Spalten kommen ohne neue Version, Programme sollten Unbekanntes überspringen.
  • Für die Übernahme in die eigene Software ist der Empfänger verantwortlich. Bei Fragen zum Format helfen wir unter hello@craftdex.de.

Auf dieser Seite