XML.DataImage - Web-Dokumentation

Sollten nicht alle Ihre Fragen auf dieser Webseite beantwortet werden, so wenden Sie sich bitte an unsere IT-Abteilung unter der kostenlosen Hotline: 0800 / 11 44 111.

Inhaltsverzeichnis

Allgemeine Funktionsbeschreibung
Request - Anfrage an den XML-Server
Response - Antwort vom XML-Server
Beispiel-Antwort des XML-Servers

1. Allgemeine Funktionsbeschreibung

Nach dem Abruf einer Daten-Auskunft mit [XML.Data][] können Sie Grafiken zur Risikoeinschätzung (RISK) und Zahlungserfahrungen (PAYD) generieren lassen. Die zurückgegebenen URLs sind unbegrenzt gültig und erfordern kein Passwort. Bitte laden Sie diese Bilder herunter und speichern diese in Ihrem System ab. Sollte dies unpraktisch sein, so speichern Sie bitte zumindest die URLs ab, damit Sie nicht jedesmal XML.DataImage aufrufen müssen.

2. Request - Anfrage an den XML-Server

struct/array	Feldname	Datentyp	Beschreibung
	SIGNON	struct	allgemeine Angaben (zur Identifizierung des Anfragenden)
SIGNON	USER_ID	int	User-ID von handelsauskunft.com (z. B. 210234)
SIGNON	PASSWORD	string	Passwort zur User-ID (Änderung im Kundenbereich der Webseite möglich)
SIGNON	SESSION_ID	string	Kann alternativ zu USER_ID und PASSWORD angegeben werden, wird von [Session.Login][] vergeben
SIGNON	CUSTOMER_DUNS	int	D-U-N-S Nr. des Kunden, für den die Auskunft abgerufen wird (siehe Vertrag)
	REQUEST	struct	Anfrage-spezifische Angaben (die ersten 3 Felder sind allerdings bei allen Anfragen enthalten)
REQUEST	CLIENT_REF	string	Aktenzeichen (der Daten-Auskunft)
REQUEST	VERSION	string	Version der XML-Schnittstelle, muß derzeit "0.1" sein
REQUEST	REASON	string	[Anfragegrund][]
REQUEST	TEST	boolean	Kostenlose Testdaten werden bei "TEST = 1" zurück geliefert. Bei "TEST = 0" oder wenn "TEST" fehlt, dann werden immer Echt-Daten abgerufen!
REQUEST	DUNS_NBR	int	D-U-N-S Nr.
REQUEST	CLIENT_REF	string	Aktenzeichen (der Daten-Auskunft)
REQUEST	RISK_SIZE	int	Größe der Grafik für die Risikoeinschätzung in Prozent; 100 % = 271 x 181 Pixel; fehlt dieser Parameter, oder ist er 0, wird keine Grafik erzeugt
REQUEST	PAYD_SIZE	int	Größe der Grafik für die Zahlungserfahrungen in Prozent; 100 % = 271 x 181 Pixel; fehlt dieser Parameter, oder ist er 0, wird keine Grafik erzeugt

3. Response - Antwort vom XML-Server

struct/array	Feldname	Datentyp	Beschreibung
	RESPONSE	struct	allgemeine Angaben (Aktenzeichen und Preis)
RESPONSE	CLIENT_REF	string	Wiederholung des Aktenzeichen
RESPONSE	SERVER_REF	string	Aktenzeichen auf Serverseite (bitte bei Rückfragen angeben)
RESPONSE	PRICE_UNITS	double	Preis der Auskunft in Einheiten
RESPONSE	PRICE_EURO	double	Preis der Auskunft in Euro (Netto-Betrag)
	DATAIMAGE	struct
DATAIMAGE	RISK_URL	string	URL zur Risikografik
DATAIMAGE	PAYD_URL	string	URL zur Zahlungsgrafik

4. Beispiel-Antwort des XML-Servers

Anfolgendes Beispiel erhalten Sie, wenn Sie bei der Anfage an den XML-Server das Parameter: TEST = 1 setzen. Die Nachfolgende Ausgabe wurde mit dem Modul: Dumper erzeugt und zeigt die Struktur der Antwort auf.

{
  'PAYD_URL' => 'https://xml.handelsauskunft.com/img/data/16390-2-100-484528.png',
  'RISK_URL' => 'https://xml.handelsauskunft.com/img/data/16390-1-100-882576.png'
};

XML.Data
Seite 6 von 15
XML.Report