Zum Inhalt springen
Start / Developer

ZepDesk für Developer

Verbinden Sie Ihre Software mit ZepDesk. Im Developer Portal beantragen Sie die Teilnahme, testen in einer eigenen Demo-Firma und reichen Ihre App zur Prüfung ein. Ihre App arbeitet über die REST-API von ZepDesk.

STANDDeveloper Portal offen
Im Developer Portal anmelden Antrag stellen

Für Ihre Anbindung: API-Dokumentation

So läuft ZepDesk Developers

Antrag

Sie beantragen die Teilnahme im Developer Portal, mit Angaben zu Ihrer Firma, Ihrem Produkt und dem Zweck der Anbindung. Teilnehmen können Unternehmen, deren Software ZepDesk ergänzt. Buchhaltungsprogramme nehmen wir nicht auf.

Developer-Konto und Demo-Firma

Nach der Freigabe melden Sie sich im Developer Portal an und bekommen eine Demo-Firma: eine eigene ZepDesk-Instanz mit Musterdaten zum Entwickeln und Testen. Sind alle Plätze belegt, stellen wir sie bereit, sobald einer frei wird.

Prüfung und Beta

Ihre App legen Sie im Portal an und reichen sie zur Prüfung ein. Nach der ersten Prüfung verbinden Sie sie mit bis zu 10 Kunden, die Sie einladen und wir freischalten. In die Beta kommen nur Apps, die Daten ausschließlich im Europäischen Wirtschaftsraum verarbeiten. Auf Daten eines Kunden greift Ihre App erst zu, wenn er zugestimmt hat.

Öffentlich unter Erweiterungen

Nach erfolgreicher Beta, frühestens 30 Tage nach ihrem Beginn, kann jeder Kunde Ihre App verbinden. Sie steht dann unter Erweiterungen, mit dem Kennzeichen „Developer-App“ und dem Hinweis „gebaut von“ mit Ihrer Firmierung.

Was wir prüfen, steht im Handbuch unter Was wir prüfen. Wie Kunden eine App verbinden und den Zugriff wieder entziehen, steht unter Developer-Apps verbinden. Es gelten die Bedingungen für ZepDesk Developers.

Die Schnittstellen

REST-API mit Referenz

Die REST-API ist versioniert. Jede Firma erreicht sie unter ihrer eigenen Adresse der Form https://ihre-firma.zepdesk.de/api/v1/. Welche Firma gemeint ist, liest ZepDesk aus der Subdomain, im Pfad steht sie nicht. Sie lesen mit GET und schreiben mit POST, jede Antwort ist JSON mit data, meta und errors. Die API-Referenz erzeugt ZepDesk aus den eigenen Routen, als OpenAPI 3.1 auf Deutsch und Englisch.

Zugang mit API-Schlüssel

Die Verwaltung der Firma legt Schlüssel in ZepDesk auf der Seite Schnittstelle an, so viele wie nötig, jeden mit eigenem Namen und einzeln widerrufbar. Ein Schlüssel gilt nur für diese Firma und arbeitet mit der Rolle, die beim Anlegen gewählt wird: Buchhaltung, Vertrieb, Steuer oder Nur-Lesen. Das Secret zeigt ZepDesk nur einmal an. Webhooks, weitere Schlüssel, Benutzer und Verwaltungseinstellungen erreicht er nicht.

Wiederholen ohne doppelte Anlage

Damit eine wiederholte Anfrage nichts doppelt anlegt, schicken Sie bei jedem POST den Kopf X-Idempotency-Key mit einem eigenen Wert. Kommt dieselbe Anfrage mit demselben Wert innerhalb von 24 Stunden noch einmal, führt ZepDesk sie nicht erneut aus und gibt die erste Antwort zurück.

Webhooks

Ein Webhook meldet Ereignisse an eine https-Adresse Ihrer Wahl, etwa an Make, Zapier oder Ihren eigenen Server. Beispiele sind eine bezahlte oder überfällige Rechnung, ein erfasster Beleg, neue Bankumsätze und ein angenommenes Angebot. Jede Nachricht ist mit HMAC-SHA256 signiert. Einrichten kann ihn die Verwaltung der Firma.

MCP für KI-Programme

Über das Model Context Protocol verbinden Sie Claude und andere MCP-fähige Programme mit Ihrer Firma, unter einer eigenen Adresse der Form https://ihre-firma.zepdesk.de/api/mcp. Das Programm meldet sich über Ihr ZepDesk-Konto an und arbeitet dann mit Ihren Rechten, oder es nutzt einen API-Schlüssel mit dessen Rolle. Eine Abgabe an das Finanzamt bleibt ein offener Vorgang und geht erst nach Freigabe in ZepDesk an ELSTER. Mehr unter KI-Assistent und MCP.

Sie planen eine App für ZepDesk und haben Fragen dazu? Schreiben Sie an developers@zepdesk.de.