Beispiele für den API Zugriff
Ein Beispiel sagt mehr als tausend Seiten Beschreibung. Daher finden Sie hier die Dokumentation unserer Schnittstellen in Form von korrekten und fehlerhaften Aufrufen samt Rückgabewerte und HTTP Statuscodes.
Die Abfrage der Gültigkeit einer Kontonummer-Bankleitzahl-Kombination besteht aus einem einfachen HTTPS GET-Aufruf (SSL ist aufgrund der Sensibilität der Daten Pflicht). Das Rückgabeformat kann dabei selbst gewählt werden.
Zur Verfügung stehen: plain text, JSON und XML.
Falls ein anderes Format gewünscht ist, kontaktieren Sie uns einfach: [email protected]
Beispiele für korrekte Aufrufe
plain text
https://ask.kontoapi.de/for/validity?key=<API-Key>&ktn=1234567&blz=12312312
Antwort (Bankverbindung gültig)
yes
Antwort (Bankverbindung ungültig)
no
JSON
https://ask.kontoapi.de/for/validity.json?key=<API-Key>&ktn=1234567&blz=12312312
Antwort (Bankverbindung gültig)
{"answer":"yes"}
Antwort (Bankverbindung ungültig)
{"answer":"no"}
XML
https://ask.kontoapi.de/for/validity.xml?key=<API-Key>&ktn=1234567&blz=12312312
Antwort (Bankverbindung gültig)
<?xml version="1.0" encoding="UTF-8"?> <response> <answer>yes</answer> </response>
Antwort (Bankverbindung ungültig)
<?xml version="1.0" encoding="UTF-8"?> <response> <answer>no</answer> </response>
Beispiele für fehlerhafte Aufrufe
plain text
https://ask.kontoapi.de/for/validity?<parameter>
Antwort (API-Key fehlt/falsch)
HTTP Status: 401 Unauthorized
error:unauthenticated
Antwort (Kontonr. oder BLZ vergessen)
HTTP Status: 400 Bad Request
error:parameters_missing
JSON
https://ask.kontoapi.de/for/validity.json?<parameter>
Antwort (API-Key fehlt/falsch)
HTTP Status: 401 Unauthorized
{"error":"unauthenticated"}
Antwort (Kontonr. oder BLZ vergessen)
HTTP Status: 400 Bad Request
{"error":"parameters_missing"}
XML
https://ask.kontoapi.de/for/validity.xml?<parameter>
Antwort (API-Key fehlt/falsch)
HTTP Status: 401 Unauthorized
<?xml version="1.0" encoding="UTF-8"?> <response> <error>unauthenticated</error> </response>
Antwort (Kontonr. oder BLZ vergessen)
HTTP Status: 400 Bad Request
<?xml version="1.0" encoding="UTF-8"?> <response> <error>parameters_missing</error> </response>
Die Abfrage des Banknamens, der zu einer Bankleitzahl gehört, besteht aus einem einfachen HTTPS GET-Aufruf (SSL ist aufgrund der Sensibilität der Daten Pflicht). Das Rückgabeformat kann dabei selbst gewählt werden.
Zur Verfügung stehen: plain text, JSON und XML.
Falls ein anderes Format gewünscht ist, kontaktieren Sie uns einfach: [email protected]
Beispiele für korrekte Aufrufe
plain text
https://ask.kontoapi.de/for/bankname?key=<API-Key>&blz=10010010
Antwort
Postbank
JSON
https://ask.kontoapi.de/for/bankname.json?key=<API-Key>&blz=10010010
Antwort
{"answer":"Postbank"}
XML
https://ask.kontoapi.de/for/bankname.xml?key=<API-Key>&blz=12312312
Antwort
<?xml version="1.0" encoding="UTF-8"?> <response> <answer>Postbank</answer> </response>
Beispiele für fehlerhafte Aufrufe
plain text
https://ask.kontoapi.de/for/bankname?<parameter>
Antwort (API-Key fehlt/falsch)
HTTP Status: 401 Unauthorized
error:unauthenticated
Antwort (BLZ vergessen)
HTTP Status: 400 Bad Request
error:parameters_missing
JSON
https://ask.kontoapi.de/for/bankname.json?<parameter>
Antwort (API-Key fehlt/falsch)
HTTP Status: 401 Unauthorized
{"error":"unauthenticated"}
Antwort (BLZ vergessen)
HTTP Status: 400 Bad Request
{"error":"parameters_missing"}
XML
https://ask.kontoapi.de/for/bankname.xml?<parameter>
Antwort (API-Key fehlt/falsch)
HTTP Status: 401 Unauthorized
<?xml version="1.0" encoding="UTF-8"?> <response> <error>unauthenticated</error> </response>
Antwort (BLZ vergessen)
HTTP Status: 400 Bad Request
<?xml version="1.0" encoding="UTF-8"?> <response> <error>parameters_missing</error> </response>
Die (z.Zt. noch entstehenden) Bibliotheken für verschiedene Programmiersprachen kümmern sich um den korrekt Aufruf der Schnittstelle und stellen das Ergebnis fertig verarbeitet zur Verfügung (z.B. als Boolean). Schauen Sie für die Verwendung der Bibliotheken bitte in die jeweilige Dokumentation.