BankerAPI V1 リファレンス

ドキュメント

banker.naoshihoshi.com

Banker APIでは金融機関を様々なWebクライアント、モバイルアプリケーションやWebサーバーから検索可能なAPIを提供しています。

APIは以下の機能を提供しています。

  • セキュアなHTTP/2 over TLS
  • オリジン間リソース共有 (Cross-Origin Resource Sharing, CORS)
  • JSONフォーマット

利用方法の詳細は以下のドキュメントをご確認ください。

エンドポイント

APIのエンドポイントです。

https://banker.naoshihoshi.com/api/v1/

認証と認可

APIキー

APIは、APIキーを使用してリクエストを認証します。 認証はリクエストヘッダーに設定されたAPIキーを介して実行されます。 すべてのAPIリクエストはHTTPSを介して行われる必要があります。

curl -H "Authorization: Token {APIキー}" -H "Content-Type: application/json" https://banker.naoshihoshi.com/api/v1/banks?code=0001

APIキーの取得

APIキーは以下の手順で取得します。

  1. ユーザー登録
  2. マイページに表示されるAPIキーを確認

API

Banker APIは、日本の金融機関の一覧を閲覧、金融機関コード、金融機関名などから金融機関情報が検索できるAPIです。 Banker APIを利用すれば、金融機関を検索する機能をカスタムWebサイト、Webサーバやモバイルアプリケーションへすぐに統合できます。

金融機関一覧取得

APIで複数の金融機関情報を取得することができます。 金融機関情報には金融機関コード、金融機関名とその読み仮名(ひらがな、カタカナ、ローマ字)が含まれます。

https://banker.naoshihoshi.com/api/v1/banks

リクエストパラメーター

GETリクエストにはURIクエリ文字列を利用します。 各パラメーターはAND条件で絞り込みを行います。

キー名 型 説明
code string 金融機関コードを検索。完全一致
name string 金融機関名を検索。部分一致
kana string 金融機関名(カタカナ)を検索。部分一致
hira string 金融機関名(ひらがな)を検索。部分一致
roma string 金融機関名(ローマ字)を検索。部分一致

レスポンス

{
  "message": "Success",
  "size": 1,
  "results": [
    {
      "code": "0001",
      "name": "みずほ",
      "kana": "ミズホ",
      "hira": "みずほ",
      "roma": "mizuho"
    }
  ]
}
キー名 型 説明
message string APIサーバーからのメッセージ
size string 取得した金融機関情報の数
results array 金融機関情報

金融機関情報

キー名 型 説明
code string 金融機関コード
name string 金融機関名
kana string 金融機関名(カタカナ)
hira string 金融機関名(ひらがな)
roma string 金融機関名(ローマ字)

支店情報一覧取得

APIで金融機関に属する複数の支店情報を取得することができます。 支店情報には支店コード、支店名とその読み仮名(ひらがな、カタカナ、ローマ字)が含まれます。

https://banker.naoshihoshi.com/api/v1/banks/{bank_code}/branches

リクエストパラメーター

GETリクエストにはURIクエリ文字列を利用します。 各パラメーターはAND条件で絞り込みを行います。

キー名 型 説明
bank_code string 支店情報を検索する金融機関コードを指定。必須。
code string 支店コードを検索。完全一致
name string 支店名を検索。部分一致
kana string 支店名(カタカナ)を検索。部分一致
hira string 支店名(ひらがな)を検索。部分一致
roma string 支店名(ローマ字)を検索。部分一致

レスポンス

{
  "message": "Success",
  "size": 1,
  "results": [
    {
      "code": "001",
      "name": "東京営業部",
      "kana": "トウキヨウ",
      "hira": "とうきよう",
      "roma": "toukiyou"
    }
  ]
}
キー名 型 説明
message string APIサーバーからのメッセージ
size string 取得した支店情報の数
results array 支店情報

支店情報

キー名 型 説明
code string 支店コード
name string 支店名
kana string 支店名(カタカナ)
hira string 支店名(ひらがな)
roma string 支店名(ローマ字)

ステータスコード

APIは以下のステータスコードを利用します。

  • 200
  • 500
  • 401