API-Zugang einrichten Praxis Desk

Erstelle einen neuen API-Zugang, damit eine externe Anwendung auf deine Offisy-Daten zugreifen kann.

Voraussetzungen

Du verfügst über die Berechtigung OAuth API-Clients verwalten in deinem Offisy-Konto.
Du bist Mitarbeiter:in der Firma. Als Kooperationsbenutzer:in kannst du keine API-Zugänge einer anderen Firma verwalten.

So gehst du vor

Öffne Einstellungen in der linken Seitenleiste.

OAuth API Clients Einstellungsseite

Wähle den Bereich OAuth / API.
Klicke auf Client erstellen.
Gib einen Client-Namen ein. Optional kannst du eine Beschreibung hinzufügen.
Wähle die Berechtigungen (Scopes) aus, die der Zugang haben soll. Vergib nur die Berechtigungen, die wirklich benötigt werden. Mehr dazu: Scopes verstehen.
Klicke auf Erstellen.

Dialog 'Neuen OAuth Client erstellen' mit den Feldern Client-Name, Beschreibung, Berechtigungen (Scopes) und den Buttons Abbrechen und Erstellen — 1Client-Name.
2Berechtigungen (Scopes): Vollzugriff oder Individuell.
3Erstellen.

Kopiere Client-ID und Client-Secret sofort.

Hinweis: Das Client-Secret wird nur einmal angezeigt. Wenn du es verlierst, musst du einen neuen Zugang erstellen. Die technische Dokumentation für Entwickler findest du in der API-Referenz.

Hinweis: Ein API-Zugang funktioniert nur, solange sein Besitzer aktiv ist.