Έγγραφα API Ανάκτησης Χαρακτηρών IBAN

Προδιαγραφές του API ενσωμάτωσης

1. Τι κάνει το API Ανάκτησης IBAN;

Αυτό το API παρέχει τη μοναδική λειτουργία ανάκτησης μέχρι δύο άγνωστων χαρακτήρων από οποιονδήποτε Αριθμό Διεθνούς Τραπεζικού Λογαριασμού. Αυτή η λειτουργία μπορεί να χρησιμοποιηθεί σε περιπτώσεις όπου τμήματα του IBAN δεν είναι αναγνώσιμα ή όταν επικυρώνεται η είσοδος χρήστη. Το σύστημα λαμβάνει υπόψη τη συγκεκριμένη μορφοποίηση και το μήκος για κάθε χώρα για να εξασφαλίσει ότι παράγει το ελάχιστο ποσό προτάσεων. Όλες οι πιθανές μεταβολές των ψηφίων και των γραμμάτων σύμφωνα με το διεθνές σχήμα μορφοποίησης ελέγχονται με βάση τον αλγόριθμο αρθρώματος ελέγχου ψηφίων.
Περιπτώσεις Χρήσης:

- Μη Αναγνωρίσιμοι Χαρακτήρες - Κατά την ψηφιοποίηση των IBAN από χαρτοφύλακες είναι πιθανό να προκύψουν μη αναγνώσιμοι χαρακτήρες από μια υποβαθμισμένη εκτύπωση. Το σύστημά μας σας επιτρέπει να τοποθετήσετε ένα ερωτηματικό "?" αντί των άγνωστων χαρακτήρων. Στη συνέχεια, η μηχανή επικύρωσης παράγει όλους τους πιθανούς έγκυρους συνδυασμούς αυτού του IBAN.

- Λογική Εικασία - Εάν έχετε ένα μη έγκυρο IBAN, μπορείτε να κάνετε μια λογική εικασία για τις θέσεις που μπορεί να είναι το σφάλμα με την εκτέλεση πολλαπλών προσπαθειών αποκατάστασης με δείκτε μπαλαντέρ "?" σε διαφορετικές θέσεις.

2. Χαρακτηριστικά


Το API Ανάκτησης IBAN σας επιτρέπει να κάνετε τα παρακάτω:

  • Να λάβετε μια λίστα έγκυρων IBAN που υποδηλώνουν την πιθανή σωστή παραλλαγή.
  • Να εξάγετε τον εγχώριο κωδικό τράπεζας από το αρχικό IBAN που υποβάλατε.
  • Να εξάγετε τον εγχώριο κωδικό υποκαταστήματος από το αρχικό IBAN που υποβάλατε.
  • Να εξάγετε τον εγχώριο αριθμό λογαριασμού από το αρχικό IBAN που υποβάλατε.

3. Αιτήματα API Ανάκτησης


Το σύστημα API επιτρέπει την αυτοματοποίηση της ανάκτησης IBAN μέσω μιας απλής αίτησης HTTP GET ή POST.
Οι αποδεκτές παράμετροι παρουσιάζονται στον παρακάτω πίνακα:

Όνομα Πεδίου Μήκος Είδος Περιγραφή
IBAN Μέγιστο 100 String Το masked IBAN που θέλετε να επικυρώσετε. Χρησιμοποιήστε "?" (ερωτηματικό) στη θέση του άγνωστου χαρακτήρα. Για παράδειγμα: DE79850?0300310018056?
κλειδί_api 128 String Το προσωπικό σας κλειδί API.
διαμόρφωση 5 String Διαμόρωση της απόκρισης XML και JSON που υποστηρίζεται.

*Για να αποκτήσετε ένα κλειδί API, παρακαλούμε επικοινωνήστε μαζί μας στο contact@iban.com ή αγοράστε μια συνδρομή στην σελίδα παραγγελιών μας

ΠΑΡΑΔΕΙΓΜΑ – Ανάκτηση ενός IBAN
Ένα παράδειγμα χρήσης του API Επικύρωσης IBAN με ένα αίτημα GET μπορεί να βρεθεί παρακάτω:

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

Όπου:
  • κλειδί είναι το κλειδί API σας
  • το IBAN στέλνεται για επικύρωση από το άρθρωμα API. Παράδειγμα: CH8?0853410203475000?
  • xml είναι η διαμόρφωση της απόκρισης. Επίσης μια λέξη κλειδί json μπορεί να οριστεί για μια απόκριση με διαμόρφωση json.

Μόλις πραγματοποιηθεί ένα αίτημα HTTP GET ή POST με το σωστό κλειδί API, το σύστημα θα επιστρέψει τα αποτελέσματα στην καθορισμένη διαμόρφωση. Μπορείτε να βρείτε ένα παράδειγμα απόκρισης στην επόμενη ενότητα “Δομή Απόκρισης API”

4. Απόκριση API Ανάκτησης


Ένα Σχήμα XSD της απόκρισης API μπορεί να βρεθεί παρακάτω:


  
    
      
        
          
            
              
              
              
              
              
              
            
          
        
        
          
            
              
            
          
        
        
      
    
  


Μπορείτε να δείτε μια λεπτομερής περιγραφή των πεδίων αντικειμένων format_data που επιστρέφονται στον παρακάτω πίνακα:

Όνομα Πεδίου Μήκος Είδος Περιγραφή
χώρα Μέγιστο 2 String Ο Κωδικός χώρας ISO 2 γραμμάτων.
μήκος_iban Μέγιστο 2 Ακέραιος Το ακριβές μήκος όλων των IBAN για αυτή τη Χώρα.
πρότυπο_διαμόρφωσης Μέγιστο 2 String Ένα πρότυπο με το ακριβές μήκος του IBAN που δείχνει τους διαφορετικούς χαρακτήρες σε κάθε θέση. C = Μικτό (Αλφάβητο + 0-9), A = Χαρακτήρας (αλφαβητικό), N = Ψηφίο (0-9).
κωδικός_τράπεζας Μέγιστο 99 String Ο εγχώριος κωδικός ταυτοποίησης τράπεζας για αυτό το IBAN.
κωδικός_υποκαταστήματος Μέγιστο 99 String Ο εγχώριος κωδικός ταυτοποίησης υποκαταστήματος για αυτό το IBAN.
αριθμός_λογαριασμού Max 99 String Ο εγχώριος αριθμός λογαριασμού τράπεζας για αυτό το IBAN.

Ένα δείγμα απάντησης XML από το API για ένα αίτημα επικύρωσης IBAN είναι:



	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	


5. Κωδικοί Κατάστασης API Ανάκτησης

Το API ανάκτησης IBAN επιστρέφει τους παρακάτω κωδικούς σφαλμάτων

Κωδικός Κατάστασης Είδος Περιγραφή
301 Σφάλμα Λογαριασμού Το Κλειδί API δεν είναι έγκυρο
302 Σφάλμα Λογαριασμού Η συνδρομή έληξε
303 Σφάλμα Λογαριασμού Κανένα ερώτημα διαθέσιμο
304 Σφάλμα Λογαριασμού Δεν έχετε πρόσβαση σε αυτό το API
401 Σφάλμα Εισαγωγής Λείπουν υποχρεωτικά πεδία.
402 Σφάλμα Εισαγωγής Πάρα πολλοί μπαλαντέρ. Επιτρέπονται μέχρι και δύο μπαλαντέρ.
403 Σφάλμα Εισαγωγής Πολύ λίγοι μπαλαντέρ. Απαιτείται τουλάχιστον ένας μπαλαντέρ.