Zum Inhalt springen
craftdexDocs

Endpunkte

Aufrufe der Schnittstelle mit Beispielen für curl und PowerShell.

Basisadresse: https://api.craftdex.de/v1. Alle Endpunkte sind GET und verlangen den Kopf Authorization: Bearer cdx_…. In den Beispielen steht der Schlüssel in der Umgebungsvariablen CRAFTDEX_KEY.

GET /v1/info

Prüft den Schlüssel und liefert eine Übersicht.

curl
curl -H "Authorization: Bearer $CRAFTDEX_KEY" https://api.craftdex.de/v1/info
PowerShell
Invoke-RestMethod -Headers @{ Authorization = "Bearer $env:CRAFTDEX_KEY" } https://api.craftdex.de/v1/info
Antwort
{
  "company": { "id": "5b0c…", "name": "Musterbau GmbH" },
  "format": "craftdex-export",
  "format_version": 1,
  "key": { "name": "Wechsel zu Firma XY", "prefix": "cdx_Ab12", "expires_at": "2026-12-20T14:05:00+00:00", "scopes": ["export:read"], "areas": null, "allowed_ips": null },
  "last_full_export_at": "2026-11-20T13:00:00+00:00",
  "files": { "count": 1284, "bytes": 2147483648 },
  "endpoints": { "export": "https://api.craftdex.de/v1/export", "export_json": "https://api.craftdex.de/v1/export.json", "files": "https://api.craftdex.de/v1/files/{ablage}/{pfad}", "docs": "https://docs.craftdex.de/schnittstelle" }
}

In key steht areas: null für alle Daten, sonst die Liste der Bereiche (zum Beispiel ["angebote", "kunden"]). allowed_ips: null heißt uneingeschränkt, sonst stehen dort die freigegebenen Adressen. files zählt nur Dateien, die der Schlüssel abrufen darf. Siehe API-Schlüssel.

GET /v1/export

Der Komplett-Export als ZIP-Datei, Aufbau wie unter ZIP-Datei beschrieben, ohne stammdaten.xlsx. Die Datei entsteht beim Herunterladen Stück für Stück. Ein vollständiger Abruf mit einem Schlüssel für alle Daten zählt als „letzter vollständiger Export“ des Betriebs. Mit einem eingeschränkten Schlüssel enthält die ZIP-Datei nur die freigegebenen Bereiche und craftdex-export.json darin das Feld areas.

curl
curl -H "Authorization: Bearer $CRAFTDEX_KEY" -o craftdex-export.zip https://api.craftdex.de/v1/export
PowerShell
Invoke-WebRequest -Headers @{ Authorization = "Bearer $env:CRAFTDEX_KEY" } -OutFile craftdex-export.zip https://api.craftdex.de/v1/export

GET /v1/export.json

Wie craftdex-export.json aus der ZIP-Datei: alle Tabellen vollständig und das Verzeichnis aller Dateien, aber ohne Dateiinhalte. Zwei Unterschiede bei den Einträgen in files:

  • sha256 und content_type sind null. Die Prüfsumme liefert der Abruf der Datei im Kopf X-Craftdex-Sha256.
  • url enthält die fertige Adresse zum Abruf der Datei.

Mit einem eingeschränkten Schlüssel enthält tables nur die Tabellen der freigegebenen Bereiche, files nur deren Dateien, und das Feld areas nennt die Bereiche.

Eintrag in files
{
  "bucket": "site-photos",
  "path": "c7e2…/1795190678846.jpg",
  "zip_path": "dateien/site-photos/c7e2…/1795190678846.jpg",
  "size": 482113,
  "sha256": null,
  "content_type": null,
  "url": "https://api.craftdex.de/v1/files/site-photos/c7e2…/1795190678846.jpg"
}

GET /v1/files/{ablage}/{pfad}

Eine Datei im Original. ablage ist der Wert bucket, pfad der Wert path aus export.json. Der Pfad darf Schrägstriche enthalten; Sonderzeichen werden wie in der Adresse üblich kodiert.

curl
curl -H "Authorization: Bearer $CRAFTDEX_KEY" -D kopf.txt -o foto.jpg \
  "https://api.craftdex.de/v1/files/site-photos/c7e2…/1795190678846.jpg"
Kopf in der AntwortBedeutung
Content-TypeDateityp, soweit bekannt
Content-LengthGröße in Byte
Content-Dispositionimmer attachment mit dem Dateinamen
X-Craftdex-Sha256SHA-256-Prüfsumme der Datei, hexadezimal

Nur Dateien des eigenen Betriebs sind erreichbar. Unbekannte Ablagen, .. im Pfad, fremde Dateien und Ablagen außerhalb der freigegebenen Bereiche ergeben 404.

Auf dieser Seite