ifsc-api

API服务器，提供Razorpay的IFSC API服务，用于查询银行分支机构详细信息。当前API根地址为<[***]>。

镜像概述和主要用途

ifsc-api是Razorpay开发的IFSC（印度系统代码）API服务器，允许用户通过多种条件（如银行代码、地区、城市等）查询银行分支机构的详细信息，包括地址、联系方式、支持的支付系统（IMPS、UPI等）。适用于科技平台、支付系统等需要集成银行分支机构信息查询功能的应用场景。

核心功能和特性

• 提供两个核心API端点：/search（高级搜索）和/places（地点层级查询）
• 支持多维度筛选：地区（ISO3166代码）、城市、银行代码等
• 返回结构化JSON响应，包含分支机构完整信息
• 支持分页查询（通过limit和offset参数）
• 轻量级Docker部署，快速启动和集成

API详细文档

Search API

用于高级搜索银行分支机构信息

查询参数

1. state：按地区筛选，需使用ISO3166代码
2. city：按城市名称筛选
3. bankcode：按银行代码筛选
4. limit：返回结果数量（分页大小）
5. offset：分页偏移量（起始位置）

响应示例

请求：/search?limit=1&offset=0&bankcode=DENS

json
{
	"BRANCH": "Delhi Nagrik Sehkari Bank IMPS",
	"CENTRE": "DELHI",
	"DISTRICT": "DELHI",
	"STATE": "MAHARASHTRA",
	"ADDRESS": "720, NEAR GHANTAGHAR, SUBZI MANDI, DELHI - ***",
	"CONTACT": "+919560344685",
	"IMPS": true,
	"CITY": "MUMBAI",
	"UPI": true,
	"MICR": "***",
	"RTGS": true,
	"NEFT": true,
	"SWIFT": "",
	"ISO3166": "IN-MH",
	"BANK": "Delhi Nagrik Sehkari Bank",
	"BANKCODE": "DENS",
	"IFSC": "YESB0DNB002"
}

Places API

用于按层级查询银行分支机构的地区、district和分支机构名称

查询参数

1. bankcode：银行代码（必填）
2. state：地区ISO3166代码（可选）
3. district：district名称（可选）

查询规则

• 仅提供bankcode：返回该银行存在的地区列表
• 提供bankcode+state：返回该银行在指定地区的district列表
• 提供bankcode+state+district：返回该银行在指定区域的分支机构列表
• 其他参数组合返回错误

响应示例

1. 仅银行代码（返回地区列表）

请求：/places?bankcode=AUBL

json
{
    "states": [
        "UTTAR PRADESH",
        "RAJASTHAN",
        "KARNATAKA",
        "GUJARAT",
        "PUNJAB",
        "MADHYA PRADESH",
        "DELHI",
        "MAHARASHTRA",
        "TAMIL NADU",
        "HARYANA",
        "WEST BENGAL",
        "TELANGANA",
        "ODISHA",
        "JAMMU AND KASHMIR",
        "KERALA",
        "CHHATTISGARH",
        "GOA",
        "ANDHRA PRADESH",
        "UTTARAKHAND",
        "BIHAR",
        "HIMACHAL PRADESH",
        "ASSAM"
    ]
}

2. 银行代码+地区（返回district列表）

请求：/places?state=IN-MP&bankcode=AUBL

json
{
    "districts": [
        "RATLAM",
        "TIKAMGARH",
        "VIDISHA",
        "INDORE",
        "MANDSAUR",
        "NEEMUCH",
        "KHARGONE",
        "DHUDHANA",
        "SEHORE",
        "DHAR",
        "SAGAR",
        "CHHINDWARA",
        "KATNI",
        "DEWAS",
        "WEST NIMAR",
        "JABALPUR",
        "BHOPAL",
        "HOSHANGABAD",
        "EAST NIMAR",
        "SHAJAPUR",
        "GWALIOR",
        "BARWANI",
        "NAJARPUR",
        "BETUL",
        "AGAR-MALWA",
        "RAJGARH",
        "CHATTARPUR",
        "RAISEN",
        "EA",
        "MANDLA",
        "KACHALIYA",
        "UJJAIN",
        "SATNA"
    ]
}

3. 完整参数（返回分支机构列表）

请求：/places?state=IN-MP&bankcode=AUBL&district=INDORE

json
{
    "branches": [
        "INDORE JAWAHAR MARG",
        "Barlai Jagir",
        "Bhanwar Kuan Road Indore",
        "AB Road Indore",
        "MG ROAD INDORE"
    ]
}

Docker部署指南

拉取镜像

bash
docker pull razorpay/ifsc:latest

运行容器

将容器3000端口映射到主机3000端口：

bash
docker run --detach --publish 3000:3000 razorpay/ifsc:latest

注：镜像标签与IFSC父仓库保持一致，可指定特定版本（如razorpay/ifsc:v1.0.0）

开发说明

本地开发环境搭建：

1. 安装依赖：

   bash
   bundle install
   

2. 确保Redis在localhost:6379运行，初始化Redis数据：

   bash
   bundle exec ruby init.rb
   

3. 启动服务器：

   bash
   bundle exec rackup
   

服务器将在http://localhost:9292可用。

许可证

代码采用MIT许可证授权（详见LICENSE文件），data/目录下内容属于公共领域。