konto_check Online API

Verfügbare Parameter

Das Skript ist zur Einbindung in andere Webseiten gedacht; die Eingabe wird über Request-Variablen gemacht, die Rückgabe erfolgt als JSON-String. Das Skript kann sowohl per http als auch per https aufgerufen werden (die eingegebenen Daten werden nicht gespeichert oder weiterverarbeitet). Der zurückgegebene String kann z.B. in PHP mit dem Befehl

$result=json_decode(file_get_contents($url),true);

in einer Variablen gespeichert werden. Für die Verarbeitung in einer Shell ist beispielsweise curl oder wget in Verbindung mit jq sehr gut geeignet.

Hier eine kurze Übersicht der (bislang) verfügbaren Übergabeparameter:

h
hilfe
help Dieses Kommando ruft diese Hilfeseite auf. Das API wird nach und nach erweitert, daher ist es keine schlechte Idee, gelegentlich hier vorbeizuschauen ;-).

jq
txt Ausgabe des Ergebnisses als Text (statt JSON). Die Ausgabe wird durch das Programm jq aufbereitet und als text/plain vom Webserver ausgeliefert.

sort Wenn dieser Parameter 1 ist, werden die Ergebnisse bei einer Suche nach BLZs sortiert ausgegeben; falls er 0 ist, erfolgt die Sortierung nach dem Suchfeld.

uniq Wenn dieser Parameter 1 ist, wird bei einer Suche von jeder BLZ nur die erste gefundene Zweigstelle (nicht unbedingt Hauptstelle) ausgegeben. Der Parameter sort wird dabei implizit mitgesetzt.

sort_uniq Dieser Parameter ist eine Kombination der beiden vorhergehenden. Falls er auf 1 gesetzt wird, werden die Ergebnisse nach BLZ sortiert ausgegeben; bei 2 wird außerdem noch uniq aufgerufen. Der Defaultwert kann in konto_check.h sowie einer PHP-INI-Datei (als konto_check.uniq) gesetzt werden

mode
bzw. m Der Parameter mode ist ein Bitfeld, das angibt, welche Aufgaben gemacht werden sollen. Mehrere Aufgaben werden durch Addition der entsprechenden Werte spezifiziert. Falls mode nicht angegeben ist, werden alle möglichen Aufgaben ausgeführt, die aufgrund der anderen Parametern möglich sind.
Der Parameter m ist ein skalarer Wert (Text) oder ein Array, falls mehrere Werte übergeben werden sollen. Er hat die gleiche Funktion wie mode, ist nur einfacher zu merken. Falls für m mehrere Werte übergeben werden sollen, ist die Arrayform anzugeben, z.B. m[]=
Die folgende Werte sind definiert:

Mode m Funktion

1 v, version Infos zur konto_check Bibliothek und LUT-Datei

2 lutinfo, lut_info Infos zur LUT-Datei

4 blzinfo alle verfügbaren Informationen zu der BLZ holen.

4 fillialinfo alle verfügbaren Filialen zu der BLZ holen.

12 bank_info,bankinfo blzinfo und filialinfo zusammen

14 info blzinfo, filialinfo und lut_info zusammen

16 blz Test einer Bankverbindung mit BLZ und Kontonummer (Einzeltest oder Array)

32 blzm Test mit BLZ und Kontonummer; dabei wird der Text der benutzten Prüfziffermethode zurückgegeben (nur beim Einzeltest)

64 pz Test einer Bankverbindung mit Prüfziffer und Kontonummer (Einzeltest oder Array)

128 pzm Test mit Prüfziffer und Kontonummer; dabei wird der Text der benutzten Prüfziffermethode zurückgegeben (nur beim Einzeltest)

256 ibantest, iban_test eine IBAN testen

512 ibangen, iban_gen eine IBAN generieren. Die IBAN wird aus blz und kto generiert; das funktioniert nur für deutsche Bankverbindungen

768 iban iban_test und iban_gen zusammen

1024 ipitest, ipi_test einen IPI (Strukturierter Verwendungszweck) testen

2048 ipigen, ipi_gen einen IPI (Strukturierter Verwendungszweck) generieren

3072 ipi ipi_test und ipi_gen zusammen

4096 suche Suche nach nach verschiedenen Kriterien

Variable Modus Beschreibung

version 1 Nähere Angabe, welche Felder des Versionsstrings ausgegeben werden sollen

blz 4, 16, 32, 512 die zu verwendende Bankleitzahl

pz 64, 128 die zu verwendende Prüfziffermethode

kto 16, 32, 64, 128, 512 die zu testende Kontonummer

blz_a 16, (32), 512 Array von zu testenden Bankleitzahlen. Im Modus 32 wird das Array auch getestet, jedoch wird kein Text der jeweils verwendeten Prüfziffermethoden ausgegeben.

pz_a 64, 128 Array der zu verwendenden Prüfziffermethoden. Im Modus 128 wird das Array auch getestet, jedoch wird kein Text der jeweils verwendeten Prüfziffermethoden ausgegeben.

kto_a 16, 64, 512 Array von zu testenden Kontonummern

zweigstelle 4 (optional) Zweigstelle der Bank. Falls nicht angegeben, wird 0 verwendet (für die Hauptstelle).

iban 256 die zu testende IBAN

ipi 1024 ein zu testende strukturierte Verwendungszweck

zweck 2048 Daten, aus dem ein Strukturierter Verwendungszweck (mit Prüfziffer) generiert werden soll

Variable	Modus	Beschreibung
version	1	Nähere Angabe, welche Felder des Versionsstrings ausgegeben werden sollen
blz	4, 16, 32, 512	die zu verwendende Bankleitzahl
pz	64, 128	die zu verwendende Prüfziffermethode
kto	16, 32, 64, 128, 512	die zu testende Kontonummer
blz_a	16, (32), 512	Array von zu testenden Bankleitzahlen. Im Modus 32 wird das Array auch getestet, jedoch wird kein Text der jeweils verwendeten Prüfziffermethoden ausgegeben.
pz_a	64, 128	Array der zu verwendenden Prüfziffermethoden. Im Modus 128 wird das Array auch getestet, jedoch wird kein Text der jeweils verwendeten Prüfziffermethoden ausgegeben.
kto_a	16, 64, 512	Array von zu testenden Kontonummern
zweigstelle	4	(optional) Zweigstelle der Bank. Falls nicht angegeben, wird 0 verwendet (für die Hauptstelle).
iban	256	die zu testende IBAN
ipi	1024	ein zu testende strukturierte Verwendungszweck
zweck	2048	Daten, aus dem ein Strukturierter Verwendungszweck (mit Prüfziffer) generiert werden soll

Symbolische Konstanten für den Mode-Parameter in PHP

Hier sind als Beispiel die PHP-Definitionen für die mode-Werte als symbolische Konstanten. In anderen Programmiersprachen läßt es sich natürlich analog handhaben:

define("VERSION",1);
define("LUT_INFO",2);
define("BLZ_INFO",4);
define("FILIAL_INFO",8);
define("BLZ_KTO",16);
define("BLZ_KTO_M",32);
define("PZ_KTO",64);
define("PZ_KTO_M",128);
define("IBAN_TEST",256);
define("IBAN_GEN",512);
define("IPI_TEST",1024);
define("IPI_GEN",2048);
define("SUCHE",4096);

Aufrufbeispiele und Rückgabeparameter

Für den Aufruf kann sowohl das http- als auch das https-Protokoll verwendet werden. Zurückgegeben wird immer ein assoziatives Array als JSON-String, bei dem für jede Berechnungsgruppe ein Element enthalten ist. Diese Elemente sind typischerweise wieder Arrays; die Teilelemente der Rückgabe sind jeweils bei den einzelnen Beschreibungen aufgeschlüsselt.

Der Parameter mode ist ein Bitfeld; durch Addition der jeweiligen Werte können daher mehrere Aufgaben mit einem Aufruf erfolgen. So lassen sich mit dem Wert mode=540 (4+8+16+512) gleichzeitig alle Infos zu einer BLZ holen, die Bankverbindung testen und die zugehörige IBAN generieren:

Der Parameter m kann wahlweise als Einzelwert oder als Array übergeben werden. Ein Einzelwert initiiert eine einzelne Berechnung, bei Übergabe eines Arrays können (wie bei mode) mehrere Berechnungen angestoßen werden. So würde mit m=blzinfo nur die Infos zu der BLZ abgerufen, mit m[]=blzinfo&m[]=blz&m=iban_gen Das obige Beispiel würde in dieser Notation so lauten:

https://www.michael-plugge.de/konto_check/api.php?m[]=blzinfo&m[]=blz&m[]=iban_gen (jq-Version) (kurze Version) (lange Version)
https://www.michael-plugge.de/konto_check/api.php?mode=268&blz=20050000&kto=101105 (jq-Version) (kurze Version) (lange Version)

Rückgabeparameter "hilfe" und "initialisierung"

Das erste Element (Index "hilfe") wird immer zurückgegeben; der Inhalt ist direkt ein Link auf diese Seite.

Das zweite Element (Index "initialisierung") ist ein Array mit den Teilelementen "status" sowie "status_txt". Diese geben den Status der Initialisierung als Zahl und Klartext wieder.

Die Rückgabewerte für diesen Aufruf sind in dem Teilarray "version" enthalten. Die folgenden Werte sind definiert:

json_version	Version des JSON API Scriptes
json_datum	Datum des JSON API Skriptes
version_string	Versionsstring der Bibliothek (lang)
version	Versionsnummer
lib_datum	Versionsdatum
kompilier_datum	Kompilierungsdatum
pz_methoden_datum	Datum der implementierten Prüfziffermethoden
iban_regel_datum	Datum der implementierten IBAN-Regeln
datum_lang	Klartext-Datum der Bibliotheksversion
version_typ	Versionstyp der Bibliothek (development, beta,final)
version_major	Versionnummer Hauptversion
version_minor	Versionnummer Unterversion