API集成规范

1. IBAN Recovery API有何作用?

此API提供了从任何国际银行帐号中恢复最大两个未知字符的独特功能。 此功能可用于IBAN的某些部分不可读或验证用户输入的情况。 系统会考虑特定的国家/地区格式和长度，以确保它产生最少量的建议。 根据国际格式化方案的所有可能的数字和字母排列都针对模数校验位算法进行测试。
用例:

- 不可读取字符 - 从纸质载体中数字化IBAN时，降级的打印可能会产生不可读的字符。 我们的系统允许您设置问号“？”代替未知的角色。然后，我们的验证引擎会为此IBAN生成所有可能的有效组合。

- 受教育猜测 - 如果您的IBAN无效，您可以通过使用通配符“？”运行多次恢复尝试，从而对错误可能位置做出有根据的猜测。不同位置的标记。

2. 功能

IBAN Recovery API允许您执行以下操作

• 获取有效IBAN列表，其中列出了可能的正确变体。
• 从提交的原始IBAN中提取国内银行代码。
• 从提交的原始IBAN中提取国内分行代码。
• 从提交的原始IBAN中提取国内帐号。.

3. 恢复API请求

API系统允许您通过简单的HTTP GET或POST请求自动执行IBAN恢复 接受的参数列在下表中：

字段名称	长度	类型	描述
IBAN	最大100	字符串	您要验证的蒙版IBAN。使用 ”？” （问号）代替未知字符。例如：DE79850？0300310018056？
api_key	128	字符串	您的个人API密钥。
格式	5	字符串	支持的响应XML和JSON的格式。

*若要获取API密钥，请通过contact@iban.com与我们联系，或通过r 购买订阅页面

示例 - 恢复IBAN
可以在下面找到带有GET请求的IBAN验证 API的示例用法：

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

其中:

• key是您的API密钥
• IBAN通过API模块发送验证。示例：CH8?0853410203475000?
• xml是响应格式。还可以为json格式的响应指定json关键字。

一旦使用正确的API密钥发出HTTP GET或POST请求，系统将以指定的格式返回结果。 您可以在下一节“API响应结构”中找到示例响应

4. 恢复API响应

API的响应的XSD架构可以在下面找到：

返回的format_data对象字段的详细说明见下表：

字段名称	长度	类型	描述
国家	最大2	字符串	2个字母的ISO国家代码。
iban_length	最大2	整数	该国家所有IBAN的确切长度。
format_template	最大2	字符串	具有IBAN精确长度的模板，显示每个位置内的不同字符。 C =混合（字母+ 0-9），A =字符（字母），N =数字（0-9）。
bank_code	最大99	字符串	IBAN的国内银行标识符代码。
branch_code	最大99	字符串	T IBAN的国内分行标识符。
account_number	最大99	字符串	IBAN的国内银行帐号。

来自API的IBAN验证查询的XML回复示例如下：

	
		CH
		21
		CCNNNNNNNCCCCCCCCCCCC
		85341
		
		0203475000
	
	
		CH810853410203475000K
		CH860853410203475000R
		CH8908534102034750002
	
	

5. 恢复API状态代码

IBAN恢复API返回以下错误代码

状态代码	类型	描述
301	帐户错误	API密钥无效
302	帐户错误	订阅已过期
303	帐户错误	无可查询
304	帐户错误	您无法访问此API I
401	输入错误	缺少必填字段。
402	输入错误	过多通配符。最多允许两个通配符。
403	输入错误	通配符过少。至少需要一个通配符。