スタートガイド
ここでは基本的なginconnectの使い方の流れを説明します。
アカウント登録を行う
新規登録 (opens in a new tab)ページから、アカウントを新規登録します。
メールアドレスとパスワードを設定します。 パスワードポリシーは以下のようになります。
- 文字数は6文字以上
- ある程度複雑なパスワードであること
- 利用文字に制限なし
利用規約に同意の上、「アカウントを作成する」ボタンを押して、登録を完了してください。
登録したメールアドレスに確認メールが送信されますので、受信したメールを確認し、メールアドレス認証を行ってください。
APIキーを取得する
新規登録またはログイン後、ダッシュボードページが表示されます。
APIを利用するためにはAPIキーが必須になります。
ダッシュボードに表示されている、APIキーの「新規登録」ボタンより、APIを作成してください。
APIキーの詳細はAPIキーについてについてのドキュメントをご確認ください。
ここでは、APIキーを以下のように入力します。
- APIキー名: サンプル
- 有効期限: 指定なし
- 許可するオリジン: localhost:3000, localhost:8000
入力が完了したら、「登録する」ボタンを押してください。
完了後にダッシュボードに遷移しますので、表示されたAPIキーをコピーしてお使いください。
APIを利用する
取得したAPIキーを使って、APIを利用してみましょう。
ターミナルからcurlを使ってAPIを利用する
Mac/Linuxの場合はターミナルを開いて(Windowsならコマンドプロンプト)、以下のコマンドを実行します。 ターミナルから利用する場合は
curl -H "Authorization: Token $YOUR_API_KEY" "https://api.ginconnect.jp/v1/banks"$YOUR_API_KEY は、先ほど生成したAPIキーを入力してください。
成功すれば以下のように結果が帰ってきます。
{
"count": 1157,
"banks": [
{
"code": "0001",
"name": "みずほ",
"katakana": "ミズホ",
"hiragana": "みずほ",
"halfKatakana": "ﾐｽﾞﾎ"
},
{
"code": "0005",
"name": "三菱ＵＦＪ",
"katakana": "ミツビシユ－エフジエイ",
"hiragana": "みつびしゆ－えふじえい",
"halfKatakana": "ﾐﾂﾋﾞｼﾕ－ｴﾌｼﾞｴｲ"
},
{
"code": "0009",
"name": "三井住友",
"katakana": "ミツイスミトモ",
"hiragana": "みついすみとも",
"halfKatakana": "ﾐﾂｲｽﾐﾄﾓ"
},
{
"code": "0010",
"name": "りそな",
"katakana": "リソナ",
"hiragana": "りそな",
"halfKatakana": "ﾘｿﾅ"
},
{
"code": "0017",
"name": "埼玉りそな",
"katakana": "サイタマリソナ",
"hiragana": "さいたまりそな",
"halfKatakana": "ｻｲﾀﾏﾘｿﾅ"
},
{
"code": "0033",
"name": "ＰａｙＰａｙ",
"katakana": "ペイペイ",
"hiragana": "ぺいぺい",
"halfKatakana": "ﾍﾟｲﾍﾟｲ"
},
{
"code": "0034",
"name": "セブン",
"katakana": "セブン",
"hiragana": "せぶん",
"halfKatakana": "ｾﾌﾞﾝ"
},
{
"code": "0035",
"name": "ソニー",
"katakana": "ソニ－",
"hiragana": "そに－",
"halfKatakana": "ｿﾆ－"
},
{
"code": "0036",
"name": "楽天",
"katakana": "ラクテン",
"hiragana": "らくてん",
"halfKatakana": "ﾗｸﾃﾝ"
},
{
"code": "0038",
"name": "住信ＳＢＩネット",
"katakana": "スミシンエスビ－アイネツト",
"hiragana": "すみしんえすび－あいねつと",
"halfKatakana": "ｽﾐｼﾝｴｽﾋﾞ－ｱｲﾈﾂﾄ"
}
]
}JavaScriptを使ってAPIを利用する
以下のようにHTMLを用意して、サーバから実行します。
<html>
<head>
<title>Bank</title>
</head>
<script>
function onFetch() {
const url = `https://api.ginconnect.jp/v1/banks`
const headers = new Headers();
headers.set('Content-Type', 'application/json');
headers.set('Authorization', 'Token <<your token>>');
fetch(url, {
method: 'GET',
headers: headers
}).then(response => response.json())
.then(data => {
console.log(data)
}).catch(error => {
console.log(error)
})
}
</script>
<body>
<button onclick="onFetch()">Fetch</button>
</body>
</html>ブラウザで表示されたfetchボタンを押すとブラウザのコンソールから取得結果が出力されます。
フィルタを使って絞り込む
ginconnectではurlパラメータとして filter というパラメータを付けることで、絞り込み条件を設定することができます。
例えば ?hiragana==み* とすると「み」からはじまる金融機関の情報が取得できます。
対応している項目は以下の通りになります。
- code: 照会先金融機関コード
- hiragana: 金融機関名（ひらがな）
- katakana: 金融機関名（カタカナ）
- half_katakana: 金融機関名フリガナ（カタカナ）
注意事項
- データ取得件数の上限は2000件です。それを超える場合は、ページネーションを利用してデータを分割して取得してください。
- フィルタ条件は正確な一致を必要とします。条件指定に不備がある場合、データが正しく返されない可能性があります。
- 認証トークンは大切に保管してください。 第三者に知られると、不正利用される恐れがあります。