<!-- このファイルはアプリの /docs ページでそのまま一般公開される(利用者向けコンテンツ)。実装ファイルのパス・ディレクトリ構成・issue番号などの内部情報を書かないこと。内部向けの仕様・実装メモは docs/ 配下へ。 -->

ginconnect API ドキュメント

ginconnectが外部提供する銀行・支店マスタAPIの利用者向けドキュメント。

本サイトが正式なAPIドキュメント。 旧ドキュメントサイト(docs.ginconnect.jp)は廃止予定で、記載内容も旧ginconnectの仕様のまま現行のAPIと乖離している。旧サイトからの差異は 公開API仕様 を参照。

目次

ドキュメント内容
スタートガイドアカウント登録からAPI呼び出しまでの手順
公開API仕様全エンドポイントの詳細仕様(認証・ページング・filter・エラー)
APIキーについてAPIキーの発行・管理とセキュリティ
試験的APIについて試験的に提供しているAPIの位置づけ
リリースノートサービスの更新履歴

APIの基本

  • ベースURL: https://api.ginconnect.jp
  • メソッド: GETのみ
  • 認証: APIキー(Authorization: Bearer <API_KEY> ヘッダー、または ?token=<API_KEY>
  • 提供API:
    • 金融機関情報API(/v1/banks/v1/banks/{code}
    • 支店情報API(/v1/banks/{code}/branches
    • Excel / Google Spreadsheet向けAPI(/v1/sheet/*

最小の呼び出し例

curl -H "Authorization: Bearer $YOUR_API_KEY" "https://api.ginconnect.jp/v1/banks"