AVS - Webservice - Datenbereitstellung für Online-Shops

AVS_Handbuch
AVS - Webservice Datenbereitstellung (PDF-Version)


1.  Allgemeines


Was ist das AVS-Webservice

Das AVS-Webservice ist eine Schnittstelle zwischen dem AVS (genauer der AVS-Datenbank) und Drittprodukten, wie beispielsweise Online-Shops oder Preisauskunftsterminals für die Apotheke.
 

Was kann das AVS-Webservice

  • Eine Liste von Pharmazentralnummern zurückgeben, die eines oder mehrere der folgenden Kriterien erfüllen:
    Lagerartikel, Besorger, Sonstige, gestrichen, mit bestimmter Klassifikation versehen (/GetPhznrList)
  • Anhand einer ans Service übermittelten Pharmazentralnummer folgende Informationen bereitstellen:
    Barcode, Produkt Bezeichnung, aktueller Lagerstand, Steuersatz in Prozent, aktueller Apotheken Verkaufspreis, Artikel  Bezeichnung, Packungsmenge, Packungseinheit, Artikelgruppe, Zulassungsnummer, Artikel gestrichen -ja/nein (/GetProdInfoList)
    und optional auch Listenpreise und Aktionspreise gesondert ausweisen (/GetProdInfoListX)
  • Eine AVS-Warenjournal Buchung eines Artikels mit folgenden Kriterien durchführen:
    Bezeichnung, Bruttobetrag, Buchungstext1, Buchungstext2, Buchungstyp, Externe Belegnummer, Menge, Pharmazentralnummer (/BookWajo)
    und optional auch Artikel ohne automatische Bestellung in den Sammelauftrag stellen (/BookWajoX)
  • Kundendaten anlegen. Im Normalfall wird das Feld Kundennummer beim Request nicht angegeben und automatisch durch das AVS vergeben. Rückgabewert ist im Erfolgsfall die Kundennummer (KundenDatenInsert)
  • Kundendaten aktualisieren. Neben der Kundennummer müssen nur die zu aktualisierenden Felder übermittelt werden. (/KundenDatenUpdate)
  • Das Bonusguthaben (0%, 10%,13%, 20%) einer übermittelten Kundennummer retournieren.
    Bonus_GetActive=1: greift auf das aktivierte Bonusguthaben zu
    Bonus_GetActive=0: greift auf ein von den AVS-Verkäufen unabhängiges, nicht aktiviertes Bonusguthaben zu (/KundenBonusGet)
  • Das Bonusguthaben (0%, 10%,13%, 20%) einer übermittelten Kundennummer aktualisieren.
    Bonus_SetActive=1: aktualisiert das aktivierte Bonusguthaben
    Bonus_SetActive=0: aktualisiert ein von den AVS-Verkäufen unabhängiges nicht aktiviertes Bonusguthaben (die Gesamtsumme pro Ust-Satz)
    Berücksichtigung dieser Werte bei der Bonusaktivierung im AVS (/KundenBonusSet)
     

Was benötigt man, um das AVS-Webservice verwenden zu können

Das AVS, einen Webserver (IIS - Internet Information Server ab Version 7.0), die Lizenz "AVS-Artikelinformation über Webservice" sowie ein Programm oder eine Website zur Kommunikation mit dem Webservice (dies ist nicht Bestandteil des Webservices!)
 

Woher bekommt die Apotheke das Webservice

Das AVS-Webservice wird in Absprache mit der Apotheke von deren Systembetreuer installiert. Die (auch testweise) Installation des AVS-Webservices muss unverzüglich dem Österreichischen Apotheker-Verlag gemeldet werden.
 

2.  Installation / technische Beschreibung


Installationsanleitung

AVS - Webservice IIS-Installation (PDF)
AVS - Webservice IIS10-Installation (PDF)


Beschreibung der Endpunkte

AVS - Webservice Ref-GetPhznrList (PDF)
AVS - Webservice Ref-GetProdInfoList (PDF)
AVS - Webservice Ref-GetProdInfoListX (PDF)
AVS - Webservice Ref-BookWajo (PDF)
AVS - Webservice Ref-BookWajoX (PDF)
AVS - Webservice Ref-KundenDatenInsert (PDF)
AVS - Webservice Ref-KundenDatenUpdate (PDF)
AVS - Webservice Ref-KundenBonusGet (PDF)
AVS - Webservice Ref-KundenBonusSet (PDF)


Ansteuerung der Endpunkte

Wenn die Produkte entsprechend gekennzeichnet sind kann man zunächst alle entsprechenden Pharmazentralnummern mit der Webservice-Methode 'GetPhznrList' ermitteln. Beispielsweise alle Artikel, die die Klassifikation 'Webshop' enthalten - unabhängig vom Lagerstatus.:

Oder alle Artikel, die die Klassifikation 'Webshop' enthalten und als Lagerartikel gekennzeichnet sind:

Oder generell alle Lagerartikel ohne Zuhilfenahme einer Klassifikation:

Anschließend kann man auf Basis dieser Liste die Detaildaten der jeweiligen PhzNr mittels ' GetProdInfoList' ermitteln.

Generell ist dabei zu beachten, dass die Artikelstammdaten in der Apotheke zu jedem Monatsersten aktualisiert werden. Es finden dabei einige tausend Artikel-Neueinschaltungen, Streichungen, Preisänderungen usw. statt. Daher müssen die Daten von Seiten des Shops regelmäßig aktualisiert werden.
 

3.  Integration / Testmöglichkeiten


Funktionstest

Ob das Webservice generell online ist, kann man durch einen Aufruf der Hilfe-Seite feststellen.
 

WsRESTClient01


Eine einfache Testmöglichkeit besteht z.B. mit dem Firefox Add-on RESTClient: https://addons.mozilla.org/de/firefox/addon/restclient/

In den unten angeführten Screenshots sehen sie jeweils einen JSON- und XML-Request mit der Response des Apothekenservers. Den Header muss man unter dem Menüpunkt „Headers“ definieren.
 

Datenformate

Json

WsRESTClient02


XML

WsRESTClient03