FAQ

Schnittstellen (API)

Übersicht

Zur Ermittlung einiger Instanz- und Arzt-spezifischer Daten bieten wir aktuell zwei offene REST-Schnittstellen an:

  • Ermittlung der Ärzte mit aktivem Online-Status einer Instanz (siehe Online-Status ändern)
    https://app.arzt-direkt.de/api/landing/<Praxis-Kennung>/online-doctors
  • Ermittlung der geplanten Verfügbarkeit einer Instanz (siehe Geplante Verfügbarkeit definieren)
    https://app.arzt-direkt.de/api/landing/<Praxis-Kennung>/planned-availability

Downloads

Swagger Schnittstellenbeschreibung

https://swagger.io/docs/

Beispiel-Implementierung auf ⇢ https://venenpraxis-jena.de/

⇢ Download-Link: Beispiel-Implementierung Online-Zeitplan

Module zum Einbetten für Ihre Website

Übersicht

Um eine unkomplizierte Implementierung und Einbindung von Funktionalitäten in Ihre Website zu ermöglichen, bieten wir momentan folgende einbettbare Module an:

  1. Geplante Sprechzeiten und Online-Status von Ärzten
    https://app.arzt-direkt.de/static/timetable/?instance=<Praxis-Kennung>

Parameter

Für die Nutzung sind von Ihnen folgende Parameter in den Zugriffs-URLs zu ersetzen:

  • <Praxis-Kennung> – Der Identifier Ihrer Praxis (Instanz). Dies ist der zweite Teil der URL Ihrer arzt-direkt-Website (https://app.arzt-direkt.de/).

Beispiel: Die URL Ihrer arzt-direkt-Seite ist https://app.arzt-direkt.de/bsp-praxis, dann ist Ihre <Praxis-Kennung> = bsp-praxis. Sie finden die statische Seite mit Ihren geplanten Sprechzeiten dann unter https://app.arzt-direkt.de/static/timetable/?instance=bsp-praxis.

Einbindung via JavaScript

Für ein optimales (responsives) Layout empfehlen wir die Einbindung mittels JavaScript. Dafür finden Sie in den folgenden Abschnitten HTML-Code, den Sie in Ihre Seite integrieren können.

Hierbei wird jeweils ein Wrapper-HTML-Element, meist ein <div>, und ein JavaScript-File mit <script> eingebunden. Das Script befüllt dieses Wrapper-Element mit Inhalten. Wir empfehlen, den <script> Tag direkt hinter das <div> zu stellen.

Hinweis: Das <script> sollte immer per URL eingebunden werden (wie im Beispiel). Einen Download und Selfhost dieses Scripts empfehlen wir ausdrücklich nicht, um mögliche Kompatibilität zwischen arzt-direkt® und diesen Komponenten auch bei zukünftigen Updates gewährleisten zu können.

Hinweis: Es folgen Code-Beispiele für die Einbindung via JavaScript. Die angegebenen Parameter sind von Ihnen zu ersetzen, siehe dazu den obigen Abschnitt zu Parametern.

Geplante Sprechzeiten und Online-Status von Ärzten

Dieses Modul zeigt – analog zu Ihrer Instanz-Startseite – die geplanten Online-Sprechzeiten (siehe Geplante Verfügbarkeit definieren) und die Online-Verfügbarkeit der Ärzte an (siehe Online-Status ändern). Um dieses Modul auf Ihrer Seite einzubinden, haben Sie mehrere Möglichkeiten, die in den Abschnitten unten beschrieben werden.

Beispiel-Ansichten

Breiter Bildschirm (PC/Laptop/Tablet):

arzt direkt handbuch module einbetten sprechzeiten online ansicht breit

Schmaler Bildschirm (Handy):

arzt direkt handbuch module einbetten sprechzeiten online ansicht schmal

Parameter

  1. <Praxis-Kennung>

Statische Seite

https://app.arzt-direkt.de/static/timetable/?instance=

Beispiel-Code

<html>
...
<body>
...
<div id="zs-arzt-direkt-timetable" data-instance0"<Praxis-Kennung>"></div>
<script src="https://arzt-direkt.com/static/timetable/index.js"></script>
...
</body>
</html>

Einbindung via iFrame

Hinweis: Wir empfehlen, die Einbindung via <iframe> zu vermeiden, um mögliche Probleme mit dem vorhandenen Design Ihrer Website zu verhindern. Außerdem könnten hier (visuelle) Probleme bei zukünftigen Updates auftauchen.

Alternativ lassen sich oben genannte Seiten auch per <iframe> Tags in HTML einbinden. Dies funktioniert am besten mit festgelegter Breite und Höhe. Auf diese Weise lässt sich ein <iframe> jedoch sehr schlecht in eine moderne (responsive) Website einbetten, ohne Probleme für das Design Ihrer Website zu bereiten. Außerdem können hierbei (visuell wenig ansprechende) Scroll-Bars erscheinen, um den gesamten Inhalt zugänglich zu machen.

Beispiel:

<html>
...
<body>
...
<iframe width="800" height="130"
src="https://arzt-direkt.com/static/timetable/?instance=<Praxis-Kennung>"
frameborder="0"></iframe>
...
</body>
</html>
Inhaltsverzeichnis

Powered By EazyDocs