銀行コード、支店コードをAPIで取得

背景

• Web API Advent Calendar 12月4日分です。

概要

• 金融機関コードを検索できるWeb APIが存在していませんでした。
• 金融機関コードを検索するREST APIをRailsで作りました。
  • https://bank.teraren.com/

サンプル

いくつかAPIの例を載せておきます。

銀行情報取得

• JSON
  • https://bank.teraren.com/banks/8457.json
• HTML
  • https://bank.teraren.com/banks/8457

支店情報取得

• JSON
  • https://bank.teraren.com/banks/8457/branches/028.json
• HTML
  • https://bank.teraren.com/banks/8457/branches/028

銀行名称から銀行一覧を取得する

• JSON
  • https://bank.teraren.com/banks/search.json?name=東京
  • https://bank.teraren.com/banks/search.json?kana=トウキョウ
• HTML
  • https://bank.teraren.com/banks/search?name=東京
  • https://bank.teraren.com/banks/search?kana=トウキョウ

支店名称から支店名を取得する

• JSON
  • https://bank.teraren.com/banks/0001/branches/search.json?name=東京
• HTML
  • https://bank.teraren.com/banks/0001/branches/search?name=東京

詳しくはドキュメントをご参照ください。

構成・工夫点とか

• ソフトウェア構成
  • Ruby 2.3 + Rails 4.2 + Unicorn + Capistrano
  • 開発環境にDocker (参考資料)
• サーバ
  • TLS
  • HTTP2
• GTMatrixでGrade Aを取れるようにUI周りをチューニングしました。
• Google Tag Managerでタグ管理を外部化
• ROA, REST
• Responsive design
• I18n 国際化 (en, ja)

まとめ

• URLは昔ですが、2015年12月にリバイズや機能を追加しました。
• 利用者がそこそこいらっしゃるようなので、データ更新機能作ります。
• ちなみに、このコードは販売中です。

TIPS: ブラウザでJSONを見やすくする

• JSON Formatter などのJSON整形用プラグインを入れておくと動作確認しやすいです。

2019/10/9 毎日、最新のマスタ情報で更新するようにしました。