Scopes verstehen Praxis Desk
Scopes sind Berechtigungen, die festlegen, auf welche Daten ein API-Zugang zugreifen darf. Du vergibst Scopes beim Erstellen eines API-Zugangs und kannst sie später jederzeit ändern, siehe API-Zugänge verwalten.
Verfügbare Scopes
| Scope | Bezeichnung | Beschreibung |
|---|---|---|
full_access | Vollzugriff | Zugriff auf alle Bereiche. Schließt alle anderen Scopes ein und ersetzt sie. |
appointments | Termine | Termine und freie Termin-Slots lesen, Termine buchen und stornieren. Zum Lesen von Terminen ist zusätzlich users nötig. |
courses | Kurse | Kurse und deren Teilnehmer lesen. Zusätzlich ist immer der Scope users nötig, für die Teilnehmerliste auch customers. |
customers | Kunden | Kunden und Kundenfelder lesen, erstellen und bearbeiten |
services | Leistungen | Leistungen und Leistungskategorien lesen |
company | Unternehmen | Unternehmensprofil und Mandanten lesen |
locations | Standorte | Standorte lesen |
users | Mitarbeiter | Mitarbeiter lesen |
executions | Leistungszuordnungen | Lesen, welcher Mitarbeiter welche Leistung an welchem Standort anbietet |
medicals | Medizinische Daten | Medizinische Patientendaten lesen und erstellen – etwa Diagnosen, Befunde, Verordnungen, Arztbriefe und Dateien. Abrechnungsleistungen lassen sich zusätzlich bearbeiten. |
invoices | Rechnungen | Rechnungen, Bareinnahmen und Honorarnoten lesen |
wares | Waren & Lager | Artikelstammdaten und Warenkategorien lesen. Bestand, Bewegungen, Bestellungen, Lagerorte und Lieferanten zusätzlich nur, wenn die Lagerverwaltung gebucht ist |
notices | Notizen | Kundennotizen lesen und erstellen |
todos | Aufgaben | Aufgaben lesen, erstellen, bearbeiten und löschen |
forms | Formulare | Formulare und versendete Formulare lesen, nur Metadaten. Antworten aus ausgefüllten Formularen und Empfängerdaten sind nie enthalten. |
dunnings | Mahnwesen | Mahnungen lesen und erstellen |
reports | Auswertungen | Umsatz- und Produktivitätsauswertungen lesen |
Hinweis: Offisy Connect nutzt den eigenen Scope
connect. Diesen Scope kannst du nicht selbst vergeben – er wird beim Verbinden eines Geräts automatisch gesetzt.
Empfehlung
Vergib immer nur die Berechtigungen, die eine Anwendung tatsächlich benötigt. Wenn eine Anwendung nur Termine auslesen soll, reichen die Scopes appointments und users aus – ein Vollzugriff ist nicht nötig.
Dieses Prinzip der minimalen Rechte schützt deine Daten: Sollte ein API-Zugang in falsche Hände geraten, ist der mögliche Schaden begrenzt.
Die vollständige technische Referenz aller Scopes findest du in der API-Referenz.