Сведения для интеграции API

1. Для чего предназначен API-интерфейс восстановления IBAN?

Данный API-интерфейс позволяет восстановить до двух недостающих символов из IBAN-номера банка. Данная функция окажется полезной при нечитаемости номера IBAN, а также для проверки данных, введенных пользователем. Данная система учитывает формат кода в выбранной стране, и гарантирует минимальное количество доступных вариантов. Все возможнные комбинации букв и цифр проходят проверку с использованием уникального алгоритма.
Примеры использования:

- Нечитаемые символы - при оцифровке IBAN-номеров с бумажных носителей код может оказаться нечитаемым из-за выцветания чернил или повреждения бумаги. Наша система позволяет заменить нечитаемый символ знаком "?". После этого система подбора кодов создает список возможных кодов для нечитаемого номера IBAN.

- Подсказка при вводе - если у вас есть неправильный номер IBAN, вы можете использовать данную систему, чтобы найти ошибку, устанавливая специальный символ "?" в разные позиции внутри кода.

2. Ключевые особенности

API-интерфейс для восстановления IBAN позволяет выполнять следующие задачи:

• Получение списка действительный IBAN для подбора правильного варианта.
• Получение внутреннего БИК с использованием полученного IBAN.
• Получение кода отделения банка с использованием полученного IBAN.
• Получение номера счета банка с использованием полученного IBAN.

3. Запросы API для восстановления

API-интерфейс позволяет автоматизировать процесс восстановления IBAN, используя простые запросы HTTP GET или POST.
Допустимые параметры представлены в данной таблице:

Название поля	Длина	Тип	Описание
IBAN	100	Строка	Зашифрованный номер IBAN, который вы хотите проверить. Используйте знак "?" вместо неизвестного символа. Например: DE79850?0300310018056?
api_key	128	Строка	Ваш личный API-ключ.
format	5	Строка	Поддерживаемые форматы ответа 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-код для проверки в системе. Например: CH8?0853410203475000?
• xml выбран в качестве формата ответа. Кроме того, вы можете указать json для получения ответа в этом формате.

После того, как запрос HTTP GET или POST отправлен с использованием правильного API-ключа, система предоставит ответ в указанном формате. Пример ответа системы вы сможете найти в следующем разделе: “Структура ответа API”

4. Структура ответа API

Схема XSD ответа API представлена ниже:

Подробная информация о каждом из полей ответа представлена в данной таблице:

Поле	Длина	Тип	Описание
country	Макс. 2	Строка	Двухзначный код страны в формате ISO.
iban_length	Макс. 2	Целое число	Точная длина IBAN для выбранной страны.
format_template	Макс. 2	Строка	Шаблон, отображающий длину IBAN кода со случайными значениями. C = смешанный (буквы и цифпы), A = только буквы, N = только цифры.
bank_code	Макс. 99	Строка	Внутренний БИК-код выбранного банка для IBAN.
branch_code	Макс. 99	Строка	Внутренний код отделения выбранного банка для IBAN.
account_number	Макс. 99	Строка	Внутренний номер счета отделения выбранного банка для IBAN.

Ниже представлен пример XML-ответа от API-интерфейса при проверке IBAN:

	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	

5. Коды состояния API

API для восстановления IBAN может отправить следующие коды ошибок:

Код ошибки	Тип	Описание
301	Ошибка учетной записи	Неправильный API-ключ
302	Ошибка учетной записи	Истек срок действия подписка
303	Ошибка учетной записи	Нет доступных запросов
304	Ошибка учетной записи	У вас нет доступа к данному API
401	Ошибка ввода	Не заполнены обязательные поля.
402	Ошибка ввода	Слишком много спец. символов. Вы можете использовать не более 2 спец. символов.
403	Ошибка ввода	Слишком мало спец. символов. Вы должны использовать не менее 1 спец. символа.