pspLogin

Schnittstellenbeschreibung / Beispiel-Code (PHP)

Einfaches Konsolen-Beispiel: Liste aller PKV-Gesellschaften
C:\> curl -H "Content-Type: application/json" -d "{\"mode\":\"getgesellschaften\", \"login_array\":{\"mandant\":\"meine_lizenznr\", \"login\":\"mein_loginname\", \"pass\":\"mein_passwort\"}}" -X POST https://www.psponline.de/webservices/psp_webservice.php oder C:\> curl -H "Content-Type: application/x-www-form-urlencoded" -d "mode=getgesellschaften&login_array={\"mandant\":\"meine_lizenznr\", \"login\":\"mein_loginname\", \"pass\":\"mein_passwort\"}" -X POST https://www.psponline.de/webservices/psp_webservice.php

Schnittstellen

Basic

getticket
liefert ein Ticket/Token zur anschließenden Berechnung eines Tarifvergleichs
gettarifvergleich
berechnet und liefert einen vollständigen Tarifvergleich zu den über getticket hinterlegten Daten

Advanced

gettarifinfo
liefert Beiträge und Merkmale zu den gewählten Tarifen
getleistungstexte
liefert die Leistungstexte zu den gewählten Tarifen in Kurz- oder Langform
getvvgdokumente
liefert die VVG-Dokumente zu den gewählten Tarifen
getbeitragshistorie
liefert die historischen Neugeschäftsbeiträge zu den gewählten Tarifen (ohne Tagegelder und GZ!)
getgesellschaften
liefert eine Liste aller PKV-Gesellschaften
gettarife
liefert eine Liste aller Tarife einer Gesellschaft, inkl. Beiträge und Merkmale
gettarifwerke
liefert eine Liste aller Tarifwerke einer Gesellschaft (z.B. zum Ausblenden von Tarifwerken über das Erfassungsfeld "geinaktiv", relevant nur für Tarifvergleich)
getleistungsthemen
liefert eine Liste aller Leistungsthemen (Ambulante Behandlungen, Vorsorgeuntersuchugen, ....)
getgkvgesellschaften
liefert eine Liste aller GKV-Gesellschaften
getbeitragstabelle
liefert die Beitragstabelle für einen Tarif
getkennzahlen
liefert eine Liste der Bilanzkennzahlen-Arten (Rfb-Quote, ...)
getbilanzkennzahlen
liefert die Bilanzkennzahlen-Werte

getticket

liefert ein Ticket/Token zur anschließenden Berechnung eines Tarifvergleichs

// Logindaten
	$login_array	= array(
		'mandant'	=> 'meine_lizenznr',
		'login' 	=> 'mein_loginname',
		'pass' 		=> 'mein_passwort',
	);

// Array mit Kunden- und VP-Daten
	$vp_array		= array();

// Kunden-Daten - VP 0 (optional, wenn nicht bestückt, werden die Daten der 1.VP als Kundendaten übernommen
	$vp_array[]		= array(
		'vp_nr'		=> 0,
		'name'		=> 'Mustermann',
		'vorname'	=> 'Max',
		'geschlecht'	=> 'M',
		'geburtsdatum'	=> '01.01.1980',
	);

// VP-Daten - VP 1,2,...
	$vp_array[]		= array(
		'vp_nr'			=> 1,
		'name'			=> 'Mustermann',
		'vorname'		=> 'Mini',
		'geschlecht'		=> 'F',				/* M=Mann, F=Frau */
		'geburtsdatum'		=> '25.05.2002',
		'versicherungsbeginn'	=> '01.05.2015',
		'vollzusatz'		=> 'Z',				/* V=Vollversicherungstarife, Z=Zusatzversicherungstarife */
		'zielgruppe'		=> 'N',				/* N=Normalversichert, M=Mediziner, B=Beamter, A=Beamtenanwärter, U=Ausbildung */
		'berufsstatus'		=> 'A',				/* A=Angestellt, S=Selbständig, F=Freiberuflich, O=nicht berufstätig */
		'knz_zahn'		=> '1',
		'proz_zahnbehandlung'	=> '0',
		'proz_zahnersatz'	=> '50',
		'proz_kfo'		=> '0',
		// Beispiel für Vergleich Zahnzusatztarife (siehe "Erfassungsfelder")
	);

// Request
	$request_array	= array(
		'mode'			=> 'getticket',
		'login_array'		=> json_encode($login_array),
		'vp_array'		=> json_encode($vp_array),
	);

// Webservice via curl
	$curl = curl_init('https://www.psponline.de/webservices/psp_webservice.php');
	curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
	curl_setopt($curl, CURLOPT_POSTFIELDS, $request_array);
	$response_json	= curl_exec($curl);
	curl_close($curl);

// Response
	$response_array	= json_decode($response_json, true);

$status		= $response_array['status'];		// 'ok' oder 'error ...'
	$token		= $response_array['token'];		// z.B. '11a9f391654ed3f8e797de6ee5445bcc'
	$url		= $response_array['url'];		// z.B. 'https://www.psponline.de/erfassung_angebot.php?token=11a9f391654ed3f8e797de6ee5445bcc'

// token kann jetzt lokal gespeichert werden, um später
	//	- das Angebot über o.g. url erneut aufzurufen oder
	//	- Berechnungsergebnisse abzuholen (über mode='getticketresult', s.u.)
	// ....

// psponline aufrufen:
	header("Location: " . $url);

gettarifvergleich

berechnet und liefert einen vollständigen Tarifvergleich zu den über getticket hinterlegten Daten

gettarifinfo

liefert Beiträge und Merkmale zu den gewählten Tarifen

// Logindaten
	$login_array	= array(
		'mandant'	=> 'meine_lizenznr',
		'login' 	=> 'mein_loginname',
		'pass' 		=> 'mein_passwort',
	);

// VP-Daten (siehe "Erfassungsfelder")
	$vp_array		= array(
		'vp_nr'			=> 1,
		'name'			=> 'Mustermann',
		'vorname'		=> 'Mini',
		'geschlecht'		=> 'F',				/* M=Mann, F=Frau */
		'geburtsdatum'		=> '25.05.2002',
		'versicherungsbeginn'	=> '01.05.2015',
		'vollzusatz'		=> 'Z',				/* V=Vollversicherungstarife, Z=Zusatzversicherungstarife */
		'zielgruppe'		=> 'N',				/* N=Normalversichert, M=Mediziner, B=Beamter, A=Beamtenanwärter, U=Ausbildung */
		'berufsstatus'		=> 'A',				/* A=Angestellt, S=Selbständig, F=Freiberuflich, O=nicht berufstätig */
	);

// Array mit tarif_id's (TG-Höhe mit '/' angeben)
	$tarif_array	= array(
		'12213',						// z.B. Allianz AktiMed Best 90U
		'12281/50',						// z.B. Allianz KTS07W
		'34185',						// z.B. Allianz PVN
	);

// Request
	$request_array	= array(
		'mode'			=> 'gettarifinfo',
		'login_array'		=> json_encode($login_array),
		'vp_array'		=> json_encode($vp_array),	// 1-dimensional (nur rel. VP) oder 2-dimensional (Kunde + alle VP's)
		'vp_nr'			=> 1,				// optional, nur wenn vp_array 2-dimensional
		'tarif_array'		=> json_encode($tarif_array),
		'token'			=> '',				// alternativ statt login_array/vp_array/vp_nr
		'kalk_id'		=> '',				// alternativ statt tarif_array
	);

// Request-Beispiel für einen Tarifvergleich
	$request_array	= array(
		'mode'			=> 'gettarifinfo',
		'token'			=> '11a9f391654ed3f8e797de6ee5445bcc',
		'kalk_id'		=> 123456,
	);

// Response
	$response_array	= json_decode($response_json, true);

$status		= $response_array['status'];			// 'ok' oder 'error ...'
	$ti_array	= $response_array['ti_array'];			// Array mit Tarifdaten: 'tarif_id', 'bereich', 'tarifname', 'beitrag_tarif', 'beitrag_gz', 'prozent_beg', 'stand', 'merkmale', 'gueltig_ab', 'gueltig_bis'

getleistungstexte

liefert die Leistungstexte zu den gewählten Tarifen in Kurz- oder Langform

// Request
	$request_array	= array(
		'mode'			=> 'getleistungstexte',
		'login_array'		=> json_encode($login_array),	// siehe Tarifinfo
		'vp_array'		=> json_encode($vp_array),	// siehe Tarifinfo (benötigt werden: geschlecht, vollzusatz, berufsstatus)
		'vp_nr'			=> 1,				// siehe Tarifinfo
		'tarif_array'		=> json_encode($tarif_array),	// siehe Tarifinfo
		'token'			=> '',				// siehe Tarifinfo
		'kalk_id'		=> '',				// siehe Tarifinfo
		'langkurz'		=> 'K',				// K=Kurztexte, L=Langtexte
		'leistungsthema_id'	=> '',				// optional Texte nur zu einem bestimmten Thema holen
	);

// Response
	$response_array	= json_decode($response_json, true);

$status		= $response_array['status'];			// 'ok' oder 'error ...'
	$text_array	= $response_array['text_array'];		// Array mit Leistungstexten: 'bereich', 'leistungsthema_id', 'leistungsthema', 'text', 'proz_bewertung'

getvvgdokumente

liefert die VVG-Dokumente zu den gewählten Tarifen

// Request
	$request_array	= array(
		'mode'			=> 'getvvgdokumente',
		'login_array'		=> json_encode($login_array),	// siehe Tarifinfo
		'vp_array'		=> json_encode($vp_array),	// siehe Tarifinfo (benötigt werden: name, vorname, geschlecht, geburtsdatum, versicherungsbeginn, vollzusatz)
		'vp_nr'			=> 1,				// siehe Tarifinfo
		'tarif_array'		=> json_encode($tarif_array),	// siehe Tarifinfo
		'token'			=> '',				// siehe Tarifinfo
		'kalk_id'		=> '',				// siehe Tarifinfo
	);

// Response
	$response_array	= json_decode($response_json, true);

$status		= $response_array['status'];			// 'ok' oder 'error ...'
	$dokument_array	= $response_array['dokument_array'];		// Array mit Dokumentdaten:
									// 'datei'		=> base64-codiertes Pdf,
									// 'bezeichnung'	=> Dokumentname,
									// 'typ'		=> 'pdf',
									// 'version'		=> (z.B. "01.01.2016"),
									// 'dokumentart'	=> 'Antrag', 'Produktinformationsblatt', 'Tarifdruckstück' oder 'weiteres Dokument'

// Dokumente können nun gespeichert oder als Links zur Verfügung gestellt werden

getbeitragshistorie

liefert die historischen Neugeschäftsbeiträge zu den gewählten Tarifen (ohne Tagegelder und GZ!)

Weitere Schnittstellen

getgesellschaften

liefert eine Liste aller PKV-Gesellschaften

gettarife

liefert eine Liste aller Tarife einer Gesellschaft, inkl. Beiträge und Merkmale

// Request
	$request_array	= array(
		'mode'			=> 'gettarife',
		'login_array'		=> json_encode($login_array),	// siehe Gesellschaften
		'vp_array'		=> json_encode($vp_array),
		'gesellschaft_id'	=> 2580,			// z.B. Allianz
		'knz_geschlossenetarife'=> '',				// '1' = auch geschlossene Tarife anzeigen
		'knz_fremdtarife'	=> '',				// '1' = auch Fremdtarife anzeigen (derzeit: Dent Happy)
	);

// Response
	$response_array	= json_decode($response_json, true);

$status		= $response_array['status'];			// 'ok' oder 'error ...'
	$ta_array	= $response_array['ta_array'];			// Array mit Tarifen: 'tarif_id', 'gesellschaft_id', 'bereich', 'tarifname', 'beitrag_tarif', 'stand', 'merkmale', 'proz_bewertung', 'gueltig_ab', 'gueltig_bis', 'beschreibung'

gettarifwerke

liefert eine Liste aller Tarifwerke einer Gesellschaft (z.B. zum Ausblenden von Tarifwerken über das Erfassungsfeld "geinaktiv", relevant nur für Tarifvergleich)

getleistungsthemen

liefert eine Liste aller Leistungsthemen (Ambulante Behandlungen, Vorsorgeuntersuchugen, ....)

getgkvgesellschaften

liefert eine Liste aller GKV-Gesellschaften

getbeitragstabelle

liefert die Beitragstabelle für einen Tarif

getkennzahlen

liefert eine Liste der Bilanzkennzahlen-Arten (Rfb-Quote, ...)

getbilanzkennzahlen

liefert die Bilanzkennzahlen-Werte

// Logindaten
	$login_array	= array(
		'mandant'	=> 'meine_lizenznr',
		'login' 	=> 'mein_loginname',
		'pass' 		=> 'mein_passwort',
	);

// Request
	$request_array	= array(
		'mode'			=> 'getbilanzkennzahlen',
		'login_array'		=> json_encode($login_array),
		'gesellschaft_id'	=> 2580,			// z.B. 2580 = Allianz (optional, ansonsten alle, oder kommaseparierte Liste)
		'kennzahl_id'		=> '1,2,5',			// z.B. 1 = RfB-Quote (optional, ansonsten alle, oder kommaseparierte Liste)
		'jahr_von'		=> 2006,			// (optional, ansonsten alle)
		'jahr_bis'		=> 2015,			// (optional, ansonsten alle)
	);

// Response
	$response_array	= json_decode($response_json, true);

$status		= $response_array['status'];			// 'ok' oder 'error ...'
	$bkz_array	= $response_array['bkz_array'];			// Array mit Bilanzkennzahlen: 'gesellschaft_id', 'kennzahl_id', 'jahr', 'wert'

psponline -Version 7.60 vom 22.05.2023 -Lizenz bestellen