Datenschutz

Developer


techn. Dokumentation der Media-Soap-Api und Msv3-Rest-Api - Stand Januar 2021


  • Deutsch
  • Englisch
  • Französisch
  • Russisch
  • Italienisch
  • Niederländisch
  • Tschechisch
  • Dänisch
  • Spanisch
  • Griechisch
  • Norwegisch
  • Polnisch
  • Portugiesisch
  • Schwedisch
  • Slowenisch

Die Schnittstelle steht über SOAP zur Verfügung. Es wird lediglich ein Zugang benötigt. Ein Testzugang oder eine Test-SOAP-Umgebung existieren nicht. Der direkte Zugriff bzw. eine Verlinkung auf die PDF-Beipackzettel ist nicht möglich. Die SOAP-Definitionsdatei (WSDL) ist unter folgendem URL abrufbar:

https://api.gebrauchs.info/interface/gebrauchsinfo.wsdl

  1. rpcTest - grundsätzliche Testanfrage, um ein SOAP-Handshake zu probieren

  2. getPZNList - Abfrage aller PZNs, zu denen ein PDF-Beipackzettel verfügbar ist

  3. getPDFLink - Abfrage eines Deeplinks des PDF-Beipackzettels zur angegebenen PZN

  4. getLMIVList - Abfrage aller PZNs, zu denen ein PDF-LMIV* verfügbar ist

  5. getLMIVLink - Abfrage eines Deeplinks des LMIV-PDF zur angegebenen PZN

  6. getBIOZIDList - Abfrage aller PZNs, zu denen ein PDF-Biozid verfügbar ist

  7. getBIOZIDLink - Abfrage eines Deeplinks des PDF-Biozid zur angegebenen PZN

  8. getRXList - Abfrage aller PZNs, zu denen ein PDF-RX verfügbar ist

  9. getRXLink - Abfrage eines Deeplinks des PDF-RX zur angegebenen PZN

  10. getAdditionalList - Abfrage aller PZNs, zu denen eine zus. Artikelinformation verfügbar ist

  11. getAdditionalData - Abfrage von zusätzlichen Artikelinformationen (Anwendungsgebiet etc.)

  12. getRatingNumber - Abfrage Anzahl/Bestand von Produktbewertungen zur angegebenen PZN

  13. getRatings - Abfrage der Produktbewertungen zur angegebenen PZN

  14. insertRating - Eintrag einer Produktbewertung zur angegebenen PZN

  15. checkItx - Prüfung auf Produkt-Wechselwirkungen

Um unnötige Anfragen an die Schnittstelle zu vermeiden, Ihre Web-Applikation nicht zu verlangsamen und dem Endanwender keine funktionslosen PDF-Links anzubieten, sollten Sie mindestens einmal täglich eine Gesamtliste aller zur Verfügung stehenden PZN-Beipackzettel abfragen - ein bis maximal dreimal pro Tag ist absolut ausreichend. Dazu dient die Funktion „getPZNList“, die PZNs als eine Liste/Array (je nach Anbindungstechnologie) zurückliefert. Diese sollten Sie vorhalten und vor Anfrage eines PDF-Deeplinks prüfen.

Diese Abfragen sind analog zu den Funktionen der Calls für PDF-Beipackzettel. Sie sind ebenfalls in jeweils zwei Funktionen unterteilt. Eine Funktion dient zur Listenabfrage der verfügbaren PZNs (getLMIVList, getBIOZIDList und getRXList) und eine Funktion dient zur Abfrage eines Links zum Artikel-PDF für LMIV, Biozid oder RX (getLMIVLink, getBIOZIDLink, getRXLink). Es gilt hier die gleiche Parametrierung wie beim Standard-Call PDF-Beipackzettel (Links sind ebenfalls 24h gültig).

Nach Übergabe der Zugangsdaten und der bestimmten PZN liefert die Funktion ein String-Array folgender Elemente zurück, sofern zusätzliche Artikelinformationen vorhanden sind.

homoeopathikum, bioprodukt → 0=nein 1=ja

biokontrollstation, beschreibung, anwendungsgebiete, gegenanzeigen, vorsichtsmassnahmen, wechselwirkungen, warnhinweise, dosierungsanleitung, anwendungsfehler, nebenwirkungen, haltbarkeit, wirkstoff_und_bestandteile, ausstelldatum_beipackzettel → Text

Liefert die Anzahl von gültigen Produktbewertungen zur angegebenen PZN. Nutzbar als Hilfsfunktion für den Aufbau einer Paginierung, da das Ergebnis-Objekt/-Array ggf. kleiner ist, als das umfassende Rückgabe-Objekt aller Produktbewertungen.

Nach Übergabe der Zugangsdaten und der bestimmten PZN liefert die Funktion ein String-Array folgender Elemente zurück, sofern Produkbewertungen vorhanden sind:

titel → Betreff

beschreibung → Anmerkungstext (inkl. evtl. Linefeeds und HTML)

autor → Autor (optionales Feld - kann leer sein)

sterne → Zahlenwert zwischen 1 und 5

zeitpunkt → Unix-Timestamp

Es kann Einfluss auf die Sortierung und den Bereich der Ergebnismenge (für Paginierung) genommen werden. Parameter offset und limit verhalten sich ähnlich zu SQL-Statements. Für die Sortierung (Parameter order) sind momentan folgende Werte gültig:

1 = Zeitpunkt absteigend

2 = Zeitpunkt aufsteigen

3 = Sterne absteigend

4 = Sterne aufsteigend

Die Daten müssen URL-Encoded und im UTF-8-Format übertragen werden. Die Felder sterne, titel, beschreibung sind Pflichtfelder. Der Wert für sterne muss zwischen 1 bis 5 liegen. Das Feld autor ist ein optionales Feld, welches leer übertragen werden kann.

Die Prüfung auf Produkt-Wechselwirkungen erfolgt auf Grundlage der beliebig übergeben PZNs, unabhängig von deren Menge. Im Fall eines Treffers bzw. einer oder mehrerer Interkationen erfolgt die Rückgabe eines umfangreichen Ergebnisses. Dieses umfasst zunächst neben dem übermittelten PZNs auch deren Artikelnamen, damit beim User eine sofortige Sichtprüfung der Artikel stattfinden kann. Des weiteren werden Themengebiete mit Volltexten zurück geliefert (z.B. Maßnahmen, Beschreibung der Wechselwirkung usw.) und Meta-Informationen, welches Datum des internen Datensatzes, Hinweistexte und ein Farbscoring beinhaltet. Mögliche Werte für das Scroing sind: gelb (Vorsicht), orange (Warnung), rot (Gefahr).

<?php

ini_set('soap.wsdl_cache_enabled', 0);
ini_set('display_errors', 1);
error_reporting(E_ALL);

$url = 'https://api.gebrauchs.info/interface/gebrauchsinfo.wsdl';
$usr = 'BENUTZERNAME';
$pwd = 'PASSWORT';
$version = 'd';

try {

	$client = new SOAPClient($url);

	//1. TEST
	print $client->rpcTest('TEST/WSDL')."<br />\n";

	//2. PZN-LISTE
	$pznliste = $client->getPZNList($usr, $pwd);

	if(count($pznliste) > 0) {

		echo '<pre>';
		var_dump( $pznliste );
		echo '</pre>';
		echo count($pznliste)." Elemente<br />\n";
	}
	else {

		echo "PZN-Liste leer<br />\n";
	}
	
	//3. PDF-LINKABFRAGE
	$link = $client->getPDFLink($usr, $pwd, '0429186', $version);
	echo '<a href="'.$link.'">'.$link.'</a>';
}
catch (SOAPFault $f) {

	print $f->faultstring;
}
Code-Snippet wurde in die Zwischenablage kopiert!
<?php

ini_set('soap.wsdl_cache_enabled', 0);
ini_set('display_errors', 1);
error_reporting(E_ALL);

$url = 'https://api.gebrauchs.info/interface/gebrauchsinfo.wsdl';
$usr = 'BENUTZERNAME';
$pwd = 'PASSWORT';

try {

	$client = new SOAPClient($url);

	//1. TEST
	print $client->rpcTest('TEST/WSDL')."<br />\n";

	//2. INTERAKTIONSCHECK
	$pzns = array(6312077, 1235544, 106, 112);

	echo '<pre>';
	$itx = $client->checkItx($usr, $pwd, $pzns);
	echo '</pre>';
}
catch (SOAPFault $f) {

	print $f->faultstring;
}
Code-Snippet wurde in die Zwischenablage kopiert!