Zum Inhalt springen
5sDesk

Funktion · API & Webhooks

5sDesk arbeitet mit Ihren übrigen Systemen

Kontakte aus Ihrer Warenwirtschaft landen ohne Abtippen im Kundenstamm, eine Anfrage aus Ihrem Shop wird zum Vorgang, ein gewonnener Auftrag meldet sich bei der Buchhaltung. REST-API und Webhooks sind in Basic und Pro enthalten.

Kostenlos testen

30 Tage testen · in der Testphase kostenlos kündbar · alle Module in jedem Tarif

API-Schlüssel mit Rechten und Befristung, daneben der Link zur OpenAPI-Dokumentation
  • REST-API v1 mit vollständiger OpenAPI-Beschreibung, öffentlich einsehbar
  • Schlüssel mit genau den Rechten, die eine Verbindung braucht, befristbar, einzeln entziehbar
  • Webhooks mit Signatur und Wiederholung bei Störungen

Im Detail

Was die Schnittstelle kann

REST-API mit OpenAPI-Beschreibung

Vorgänge, Nachrichten, Kunden, Firmen, Karten und Deals lesen und schreiben. Die vollständige Beschreibung aller Funktionen ist öffentlich einsehbar, auch vor der Registrierung, und jederzeit aktuell. Wiederholt ein angebundenes System einen Auftrag, weil eine Antwort unterwegs verloren ging, entsteht trotzdem nur ein Vorgang.

  • OpenAPI-Dokumentation ohne Anmeldung lesbar
  • Schutz gegen doppelte Einträge bei Wiederholungen
  • Im Verlauf eines Vorgangs sichtbar, welche Verbindung was getan hat
Zur API-Dokumentation
Basis-URL der API

Schlüssel mit genau den nötigen Rechten

Ein Zugangsschlüssel wird in den Einstellungen angelegt, mit genau den Rechten, die die jeweilige Verbindung braucht: nur lesen, nur Kundendaten, nur Vertriebskarten. Jeder Schlüssel lässt sich benennen, befristen und einzeln entziehen, ohne die anderen Verbindungen zu stören.

  • Fein abgestufte Rechte je Schlüssel
  • Befristung und einzelner Entzug
  • Verschlüsselt gespeichert
Neuer API-Schlüssel mit genau den nötigen Berechtigungen

Webhooks: 5sDesk meldet sich, statt gefragt zu werden

Sie hinterlegen eine Adresse und wählen aus, worüber Sie informiert werden wollen: neue Vorgänge, eingehende Nachrichten, geänderte Kundendaten, bewegte Vertriebskarten. Jede Meldung ist signiert, sodass Ihr System sicher erkennt, dass sie von 5sDesk stammt. Ist Ihr System kurz nicht erreichbar, wird die Meldung mehrfach wiederholt, und im Verlauf sehen Sie, was zugestellt wurde.

  • Ereignisse je Webhook wählbar
  • Signatur je Meldung
  • Wiederholung und Zustellprotokoll
Webhook-Ziel anlegen mit Ereignissen und Hinweis zur Rechtsgrundlage

Verknüpft mit

Greift ineinander mit diesen Funktionen

Für wen

Besonders wertvoll für

Häufige Fragen

In welchen Tarifen sind API und Webhooks enthalten?
In Basic und Pro. Starter enthält alle Module, aber keinen API-Zugang.
Wo finde ich die API-Dokumentation?
Öffentlich unter docs.5sdesk.com/api/docs, als OpenAPI-Beschreibung, die immer dem aktuellen Stand entspricht. Wie Sie Schlüssel in den Einstellungen anlegen, zeigt die Anleitung zu den API-Schlüsseln.
Wie verbinde ich 5sDesk mit unserer Warenwirtschaft?
Über die REST-API für Kundenstammdaten und Vorgänge und über Webhooks für Ereignisse, etwa einen gewonnenen Deal. Wer keine eigene Entwicklung hat, nutzt eine Integrationsplattform, die REST-APIs und Webhooks anspricht.
Wie sicher sind die Webhooks?
Jede Meldung ist signiert, Ihr System prüft die Signatur und erkennt so, dass die Meldung von 5sDesk stammt. Zustellversuche werden protokolliert, bei Störungen wiederholt.

Anbinden statt abtippen

Schlüssel anlegen, ersten Webhook einrichten. 30 Tage testen in Basic oder Pro.

Kostenlos testen

30 Tage testen · in der Testphase kostenlos kündbar · alle Module in jedem Tarif