Amparex Konnektor

Der Amparex Konnektor stellt die Schnittstelle zwischen Amparex und Syncler dar.
Die Anbindung erfolgt über die offizielle REST API von Amparex und ermöglicht den bidirektionalen Austausch von Daten.

Unterstützt werden dabei zentrale Geschäftsobjekte wie Adressen, Termine, Artikel und Kundenstammdaten.


Voraussetzungen

Um die API nutzen zu können, müssen folgende Schritte durchgeführt werden:

  1. Rufen Sie die Alias-ID Ihres Anmeldekontos aus der Amparex Software ab:

    • Navigieren Sie in der Software zur FilialenverwaltungDienstkonten.
    • Wählen Sie Ihr Dienstkonto aus und kopieren Sie das Alias-Token.
  2. Verwenden Sie zur Anmeldung die URL:

/alias//login

Ersetzen Sie {alias} durch die kopierte Alias-ID und authentifizieren Sie sich mit Ihren Anmeldedaten.

  1. Nach erfolgreicher Authentifizierung steht Ihnen ein gültiges Login-Token zur Verfügung.

⚠️ Hinweis:

  • Stellen Sie sicher, dass das Dienstkonto über ausreichende Rechte verfügt, um Lesen und Schreiben auf den gewünschten Objekten zu ermöglichen.
  • Ohne gültigen Alias-Token ist keine Verbindung über die REST API möglich.

Einrichtung

1. Neues System anlegen

  • Legen Sie in Syncler ein neues System mit dem Konnektor „Amparex“ an.
  • Tragen Sie dort die Alias-ID, die Login-URL und die erforderlichen Zugangsdaten ein.

image

2. Verbindung testen

  • Speichern Sie das System.
  • Syncler prüft die Erreichbarkeit der API und die Gültigkeit der Zugangsdaten.
  • Fehler oder fehlende Berechtigungen werden angezeigt.

Objekte

Der Konnektor stellt folgende Schemaobjekte bereit, die direkt über Syncs verwendet werden können:

  • Address – Adressdaten, Stammdaten für Kontakte und Kunden
  • Appointment – Termine und Terminverwaltung
  • Article – Artikelstammdaten
  • Branch – Informationen zu Filialen / Niederlassungen
  • Comment – Kommentare und Notizen
  • Customer – Kundendaten inklusive Stammdatenverwaltung
  • Doctor – Arztstammdaten und Zuweiserverwaltung
  • HearingCare – Datenobjekte für Hörgeräteversorgung

Lesen von Daten

  • Das Lesen von Daten ist grundsätzlich möglich:
  • Einzelne Datensätze können gezielt abgefragt werden.
  • Abfragen können auch als Liste ausgeführt werden.
  • Änderungsabfragen werden unterstützt:
  • Nicht jedes Objekt verfügt über ein Änderungsdatum.
  • Beispiel:
  • Das Schemaobjekt HearingCare stellt nur ein Anlagedatum zur Verfügung. Dieses wird bei Änderungsabfragen als Referenz genutzt.

Schreiben von Daten

  • Das Schreiben von Daten ist für alle Schemaobjekte möglich.
  • Unterstützt werden:
  • Erstellen neuer Datensätze
  • Aktualisieren bestehender Datensätze