Specifica di integrazione dell'API

1. Cosa fa l'API di ripristino IBAN?

Questa API fornisce la funzionalità unica per recuperare fino a due caratteri sconosciuti da qualsiasi numero di conto bancario internazionale. Questa funzione può essere utilizzata nei casi in cui parti dell'IBAN sono illeggibili o quando l'input dell'utente viene convalidato. Il sistema tiene conto della specifica formattazione e lunghezza del Paese per garantire che produca la quantità minima di suggerimenti. Tutte le possibili permutazioni di cifre e lettere in base allo schema di formattazione internazionale vengono testate con l'algoritmo della cifra di controllo modulust.
Casi d'uso:

- Caratteri illeggibili - Quando si digitalizzano gli IBAN da supporti di carta, è possibile che la stampa degradata produca caratteri illeggibili. Il nostro sistema ti consente di inserire un punto interrogativo "?" al posto dei caratteri sconosciuti. Il nostro motore di convalida genera quindi tutte le possibili combinazioni valide per questo IBAN.

- Ipotesi plausibile - Se hai un IBAN non valido, puoi fare un'ipotesi plausibile su quali posizioni potrebbe essere l'errore eseguendo più tentativi di recupero con carattere jolly "?" come marcatori in diverse posizioni.

2. Caratteristiche

L'API di ripristino IBAN ti consente di effettuare le seguenti operazioni:

• Ottieni un elenco di IBAN validi che suggeriscono la possibile variante corretta.
• Estrarre il codice bancario nazionale dall'IBAN originale inviato.
• Estrarre il codice filiale nazionale dall'IBAN originale inviato.
• Estrarre il numero di conto interno dall'IBAN originale inviato.

3. Richieste API di ripristino

Il sistema API consente di automatizzare il ripristino IBAN tramite una semplice richiesta HTTP GET o POST.
I parametri accettati sono elencati nella tabella seguente:

Nome del campo	Lunghezza	Tipo	Descrizione
IBAN	Max 100	Stringa	L'IBAN mascherato che vuoi convalidare. Usa "?" (punto interrogativo) al posto del carattere sconosciuto. Ad esempio: DE79850?0300310018056?
api_key	128	Stringa	La tua chiave API personale.
format	5	Stringa	Formato della risposta XML e JSON supportati.

* Per ottenere una chiave API, ti preghiamo di contattarci all'indirizzo contact@iban.com o di acquistare un abbonamento nella nostra pagina degli ordini

ESEMPIO - Recuperare un IBAN
Di seguito è riportato un utilizzo di esempio dell'API di convalida IBAN con una richiesta GET:

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

Dove:

• la chiave è la tua chiave API
• IBAN inviato per la convalida dal modulo API. Esempio: CH8?0853410203475000?
• xml è il formato di risposta. È inoltre possibile specificare una parola chiave json per la risposta in formato json.

Una volta che una richiesta HTTP GET o POST viene eseguita con la chiave API corretta, il sistema restituirà i risultati nel formato specificato. Puoi trovare una risposta di esempio nella prossima sezione "Struttura delle risposte API"

4. Risposta all'API di ripristino

Di seguito è riportato uno schema XSD della risposta dell'API:

Una tabella dettagliata dei campi oggetto format_data restituiti può essere vista nella tabella seguente:

Nome del campo	Lunghezza	Tipo	Descrizione
country	Max 2	Stringa	Il codice paese ISO di 2 lettere.
iban_length	Max 2	Numero intero	La lunghezza esatta di tutti gli IBAN per questo Paese.
format_template	Max 2	Stringa	Un modello con la lunghezza esatta dell'IBAN che mostra i diversi caratteri all'interno delle posizioni. C = Misto (Alfabeto + 0-9), A = Carattere (alfabetico), N = Cifra (0-9).
bank_code	Max 99	Stringa	Il codice identificativo della banca nazionale per questo IBAN.
branch_code	Max 99	Stringa	L'identificatore di filiale nazionale per questo IBAN.
account_number	Max 99	Stringa	Il numero di conto bancario nazionale per questo IBAN.

Una risposta XML di esempio dall'API per una query di convalida IBAN potrebbe essere:

	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	

5. Codici di stato dell'API di ripristino

L'API di ripristino IBAN restituisce i seguenti codici di errore

Codice di stato	Tipo	Descrizione
301	Errore Account	La chiave API non è valida
302	Errore Account	Abbonamento scaduto
303	Errore Account	Nessuna query disponibile
304	Errore Account	Non hai accesso a questa API
401	Errore di input	Campi obbligatori mancanti.
402	Errore di input	Troppi caratteri jolly. È consentito un massimo di due caratteri jolly.
403	Errore di input	Pochi caratteri jolly. È richiesto almeno un carattere jolly.