Developer · OAuth 2.0
Mit Dentra anmelden
OAuth 2.0 und OpenID Connect: Praxen melden sich mit dem Button «Mit Dentra anmelden» in deiner App an, ohne weiteres Passwort. Du erfährst, wer sie sind, und mit ihrer Zustimmung die Daten ihrer Praxis.
So funktioniert es
«Mit Dentra anmelden» folgt den Standards OAuth 2.0 und OpenID Connect: Deine App öffnet eine Dentra-Seite, die Praxis meldet sich an und stimmt auf einem Zustimmungsbildschirm zu, und deine App erhält Schlüssel, um zu wissen, wer sie ist, und das Freigegebene zu lesen.
Es funktioniert für Desktop-Apps, die kein Geheimnis aufbewahren können, und für Websites mit Server. Das Dentra-Konto ist das der Praxis: ein Konto, eine Praxis.
Bis wir sie freigeben, ist deine App im Testmodus: Sie öffnet sich nur mit deinem eigenen Dentra-Konto und erhält die Daten einer Beispielpraxis. Nach der Freigabe öffnet sie sich für alle Praxen.
Die App registrieren
- Du brauchst ein Dentra-Konto mit Developer-Zugang: Du beantragst ihn in /app unter «Developer» im Kontomenü.
- Auf der Developer-Seite, Reiter «Mit Dentra anmelden», drückst du «Anwendung registrieren» und gibst Namen, Art der App, Verantwortlichen für die Daten, Link zu deiner Datenschutzerklärung, Rücksprungadressen und benötigte Berechtigungen an.
- Du erhältst den Code der App (client_id). Eine Website erhält auch ein Geheimnis, das nur einmal angezeigt wird. Eine Desktop-App hat kein Geheimnis: Sie schützt PKCE.
- Lade dein Logo hoch (PNG, JPG oder WEBP, bis 512 KB): Es erscheint auf dem Zustimmungsbildschirm mit dem Namen des Verantwortlichen und dem Link zu deiner Datenschutzerklärung, die über https erreichbar sein muss.
- Die Rücksprungadressen einer Website laufen über https (http nur auf 127.0.0.1, für lokale Tests). Die einer Desktop-App sind http://127.0.0.1/<pfad>, ohne Port und nie localhost, oder ein eigenes Schema. Rücksprungadressen, Abmeldeadressen und Logo änderst du jederzeit; die Berechtigungen wählst du bei der Registrierung, danach lassen sie sich nicht mehr ändern.
Das Discovery-Dokument
Die Adressen von OAuth und OpenID Connect stehen auch im Discovery-Dokument; die der API (/api/v1) nicht.
- discovery
- https://dentra.it/.well-known/openid-configuration
Die Adressen
Geschützt
Öffnet sich, wenn du dich mit aktivem Developer-Zugang anmeldest.
Die Verbindung Schritt für Schritt
Geschützt
Öffnet sich, wenn du dich mit aktivem Developer-Zugang anmeldest.
Berechtigungen
Frage nur an, was du brauchst: Der Zustimmungsbildschirm listet jede Berechtigung auf, und du kannst nur die für deine App registrierten anfragen.
Jede App hat openid, email und profile. openid fragst du bei jeder Anmeldung an: Es sagt, wer es ist, mit einer Kennung, die sich nie ändert. email und profile (der Name) kommen im id_token, über userinfo und in user von /api/v1/me nur, wenn du sie anfragst: Ohne sie sind diese Felder null.
- offline_access
- Bleibt verbunden: Du erhältst auch einen Erneuerungsschlüssel.
- clinic:read
- Die Praxis: Name, USt-IdNr., Adresse, Kontakte, aktive Dentra-Systeme. Fügt clinic_id zur Anmeldung hinzu.
- orders:read
- Offene Aufträge: Nummer, Status, Termine und Art der Arbeit. Niemals Patientendaten.
- preferences:read
- Die klinischen Präferenzen der Praxis.
- systems:read
- Dentra-Systeme: welche es gibt, welche die Praxis hat, mit welchem Tarif und wie deine App sie nutzt (GET /api/v1/systems).
- oralsnap:model
- Oralsnap Model eingebettet in deiner App nutzen: Der Scan bleibt auf dem Computer der Praxis.
Schlüssel, Erneuerung und Abmeldung
Geschützt
Öffnet sich, wenn du dich mit aktivem Developer-Zugang anmeldest.
Die Praxisdaten
Geschützt
Öffnet sich, wenn du dich mit aktivem Developer-Zugang anmeldest.
Dentra-Systeme in deiner App
Geschützt
Öffnet sich, wenn du dich mit aktivem Developer-Zugang anmeldest.
Das Abo
Geschützt
Öffnet sich, wenn du dich mit aktivem Developer-Zugang anmeldest.
Regeln und Datenschutz
- Sobald die Praxis zustimmt, bist du Verantwortlicher für die erhaltenen Daten: Du verarbeitest sie nach deiner Datenschutzerklärung, die auf dem Zustimmungsbildschirm erscheint.
- Du erhältst nie Patientendaten, Dateien, Rechnungen oder die Erinnerungen des Dentra-Assistenten und kannst nichts im Namen der Praxis bestellen oder ändern.
- Stelle deine App nicht als Dentra-Produkt dar: Der Bildschirm sagt immer, wem sie gehört.