Wie muss eine API-Anfrage aussehen?

Die API kann über HTTP GET/POST Requests angesprochen werden.
Hier finden Sie ein Beispiel anhand eines php Scripts.

Um eine IBAN zu prüfen:
Senden sie Ihre Anfrage an folgende URL: https://www.iban-test.de/api/check/{iban}?authcode={authcode}

Ersetzen sie hierbei Folgendes:
{iban} = die zu überprüfende IBAN
{authcode} = Ihr API Schlüssel.

Um eine IBAN zu erzeugen:
Senden sie Ihre Anfrage an folgende URL:
https://www.iban-test.de/api/generate?authcode={authcode}&bankcode={blz}&accountnumber={ktn}&countrycode={cc}

Ersetzen Sie hierbei Folgendes:
{authcode} = Ihr API Schlüssel
{blz} = die Bankleitzahl
{ktn} = die Kontonummer
{cc} = der Ländercode (z.B. DE)

Um Informationen über einen Authcode abzufragen:
Senden sie Ihre Anfrage an folgende URL:
https://www.iban-test.de/api/info/{authcode}

Ersetzen Sie hierbei Folgendes:
{authcode} = Authcode über den Sie Informationen abfragen möchten

Hinweis: Diese Abfage wird Ihren täglichen Abfragen nicht angerechnet und benötigt keinen Authcode als GET/POST-Parameter.

Um Informationen über deutsche Bank-Daten abzufragen:
Senden sie Ihre Anfrage an folgende URL:
https://www.iban-test.de/api/blz-test?authcode={authcode}&blz={blz}&ktn={ktn}/

Ersetzen Sie hierbei Folgendes:
{authcode} = Ihr API Schlüssel
{blz} = eine deutsche Bankleitzahl
{ktn} = eine deutsche Kontonummer

Wie sieht die Antwort der API aus?

Die Antwort auf eine API-Anfrage ist immer ein als JSON String codiertes Array. Dieses enthält folgende Felder:
error = Boolean - Gab es einen Fehler?
code = Integer - Ein Code, der das Ergebnis der Abfrage anzeigt. Eine Liste mit allen Status Codes finden Sie hier.
message = String - Ergebnis der Abfrage in Textform.

Zusätzlich beim Prüfen einer deutschen IBAN erhalten Sie ein Feld mit dem Namen "details" mit folgendem Inhalt:
validBank = Boolean - Ist die Bank(leitzahl) gültig?
validAccount = Boolean - Ist die Kontonummer gültig?
bankName = String - Name der Bank
bankCity = String - Stadt der
Bankbic = String - BIC der Bank

Zusätzlich beim Erzeugen einer IBAN erhalten Sie folgende Felder:
iban = String - Die erzeugte IBAN.
iban_formatted = String - Die formatiert erzeugte IBAN (Leerzeichen nach je 4 Zeichen).

Zusätzlich beim Abfragen von Informationen eines Authcodes erhalten Sie ein Feld mit dem Namen "info" mit folgendem Inhalt:
maxRequests = Integer - Die maximale Anzahl an Anfragen pro Tag.
requestsToday = Integer - Die Anzahl der heutigen Anfragen.
requestsAll = Integer - Die Anzahl aller jemaligen Anfragen.
lastRequestTime = Integer - UNIX-Zeitstempel der letzten Anfrage.
firstRequestTime = Integer - UNIX-Zeitstempel der allerersten Anfrage.

Zusätzlich beim Abfragen von Informationen zu deutschen Bank-Daten erhalten Sie die Felder "bank" und "konto" mit folgendem Inhalt:
[bank] name = String - Name der Bank.
city = String - Stadt der Bank.
shortTerm = String - Kürzel der Bank.
postcode = Integer - Postleitzahl der Bank.
bic = Integer - BIC der Bank.
valid = Boolean - Ist es eine gültige Bankleitzahl?
[konto] valid = Boolean - Ist es eine gültige Kontonummer?
number = Integer - Die Kontonummer selbst.

Ihre API ist deaktiviert oder Gesperrt ?

Das kann zum einen daran liegen das sie Ihr Limit der Abfragen pro Tag erreicht haben.
In diesem Fall müssen Sie entweder warten bis der 24h Reset eintritt der bei Ihren ersten Abfrage beginnt zu zählen.
Oder optional Ihr Limit durch eines unserer Pakete erhöhen.

Ihre APi kann auch durch missbrauch oder ähnliches gesperrt werden.
In diesem Fall nehmen Sie Kontakt mit unserem Support auf, dieser wird Sie aufklären.