API specifikacija integracije

1. Što radi IBAN API za oporavak?

Ovaj API pruža jedinstvenu funkcionalnost za oporavak do dva nepoznata znaka iz bilo kojeg broja međunarodnog bankovnog računa. Ova se funkcija može koristiti u slučajevima kada dijelovi IBAN-a nisu čitljivi ili kada se potvrdi korisnički unos. Sustav uzima u obzir specifičan oblik i duljinu zemlje kako bi se osiguralo da proizvodi minimalnu količinu prijedloga. Sve moguće permutacije znamenki i slova prema međunarodnoj shemi oblikovanja testirane su protiv algoritma kontrolne znamenke modula.
Upotrijebite slučajeve:

- Nečitljivi znakovi - Kod digitalizacije IBAN-ova iz papirnih nosača moguće je da degradirani ispis proizvodi nečitke znakove. Naš sustav vam omogućuje postavljanje upitnika "?" umjesto nepoznatih znakova. Naš validacijski sustav generira sve moguće valjane kombinacije za ovaj IBAN.

- Pretpostavka - ako imate nevažeći IBAN, možete pretpostaviti na kojim mjestima se nalazi pogreška izvršavanjem više pokušaja oporavka zamjenskim znakom "?" s markerima na različitim pozicijama.

2. Značajke

IBAN Recovery API omogućuje vam da učinite sljedeće:

• Dohvatite popis važećih IBAN-ova koji predlažu moguću ispravnu varijantu.
• Izvadite domaći bankovni kôd iz originalnog IBAN-a.
• Izvucite šifru podružnice iz izvornog IBAN-a.
• Izvucite broj domaćeg računa iz originalnog IBAN-a.

3. Zahtjevi API-a za Oporavak

Sustav API-ja omogućuje automatizaciju IBAN oporavka putem jednostavnog HTTP GET ili POST zahtjeva.
Prihvaćeni parametri navedeni su u donjoj tablici:

Naziv Polja	Duljina	Tip	Opis
IBAN	Max 100	Niz	Želite potvrditi maskirani IBAN. Koristite "?" (upitnik) umjesto nepoznatog znaka. Npr.: DE79850?0300310018056?
api_key	128	Niz	Vaš osobni API ključ.
format	5	Niz	Oblik XML i JSON odgovora.

*TDa biste dobili API ključ, kontaktirajte nas na contact@iban.com ili kupite pretplatu na našoj stranici za narudžbu

PRIMJER – Obnova IBAN-a
Primjer korištenja IBAN-ova za validaciju API-ja s GET zahtjevom može se naći u nastavku:

https://api.iban.com/clients/api/recover-iban.php?api_key=key&format=xml&iban=IBAN

Where:

• key je vaš API ključ
• IBAN je poslan na provjeru putem API modula. Primjer: CH8?0853410203475000?
• xml je format odgovora. Također, jsonova ključna riječ može se odrediti za json formatirani odgovor.

Nakon što se HTTP GET ili POST zahtjev izvrši s ispravnim API ključem, sustav će vratiti rezultate u navedenom formatu. Primjer odgovora možete pronaći u sljedećoj sekciji “API Stuktura Odgovora”

4. Odgovor API-a za Obnovu

XSD Shema odgovora API-ja može se pronaći u nastavku:

Detaljni opis format_data object polja može se vidjeti u donjoj tablici:

Naziv Polja	Dužina	Tip	Opis
country	Max 2	Niz	ISO šifra zemlje s 2 slova.
iban_length	Max 2	Integer	Točna duljina svih IBAN-ova za ovu zemlju.
format_template	Max 2	Niz	Predložak s točnom duljinom IBAN-a koji prikazuje različite znakove unutar pozicija. C = mješoviti (abecedni + 0-9), A = znak (abecedni), N = broj (0-9).
bank_code	Max 99	String	Kodeks identifikatora domaće banke za ovaj IBAN.
branch_code	Max 99	Niz	Identifikacija domaće podružnice za ovaj IBAN.
account_number	Max 99	Niz	Broj domaćeg bankovnog računa za ovaj IBAN.

Primjer XML odgovora API-ja za upit IBAN provjere valjanosti bio bi:

	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	

5. Statusni kodovi API-ja za oporavak

IBAN recovery API vraća sljedeće kodove pogrešaka

Kod Statusa	Tip	Opis
301	Pogreška računa	API Ključ je nevažeći
302	Pogreška računa	Pretplata je istekla
303	Pogreška računa	Nema dostupnih upita
304	Pogreška računa	Nemate pristup ovom API-ju
401	Greška unosa	Nedostaju obavezna polja.
402	Greška unosa	Previše zamjenskih znakova. Dopuštene su najviše dvije zamjenske oznake.
403	Greška unosa	Previše zamjenskih znakova. Potreban je najmanje jedan zamjenski znak.