メインコンテンツへスキップ
本文では、銀行カード基本情報照会 API 接続説明について紹介します。これは銀行カード基本情報の照会に使用できます。

申請プロセス

API を使用するには、まず 銀行カード基本情報照会 API の該当ページでサービスを申請する必要があります。ページに入ったら、「Acquire」ボタンをクリックします。以下の図のように: まだログインまたは登録していない場合、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。 初回申請時には無料の利用枠が付与され、この API を無料で使用できます。

基本使用

まず基本的な使用方法を理解します。銀行カード番号を入力することで、処理された検証結果を得ることができます。まず、bank_card フィールドを簡単に渡す必要があります。次に、画面上に対応する内容を入力できます。以下の図のように:

ここでは、Request Headers を設定しています。これには以下が含まれます:
  • accept:受け取りたいレスポンス結果の形式。ここでは application/json、つまり JSON 形式を記入します。
  • authorization:API を呼び出すためのキー。申請後、直接ドロップダウンから選択できます。
さらに、Request Body を設定しています。これには以下が含まれます:
  • bank_card:銀行カード番号。
  • encryption:オプション、機密フィールドの暗号化パラメータ(暗号文を送信する必要がある場合)。
選択後、右側にも対応するコードが生成されていることがわかります。以下の図のように:

「Try」ボタンをクリックするとテストが実行できます。上の図のように、以下の結果が得られました:
{
  "result": "0",
  "description": "照会成功",
  "account_bank": "工商銀行",
  "account_type": 1
}
返された結果には複数のフィールドがあり、以下のように説明されます:
  • result,認証結果コード、料金状況は以下の通りです。
    • 料金結果コード:
      • 0: 照会成功
      • -1: 情報が見つかりません
    • 無料結果コード:
      • -2: 検証センターサービスが混雑しています
      • -3: 銀行カードが存在しません
  • description,業務結果の説明。
  • account_bank,口座銀行。
  • account_type,カードの性質:1. デビットカード;2. クレジットカード;3. プリペイドカード;4. 準クレジットカード。
銀行カード基本情報が照会されていることがわかります。 また、対応する接続コードを生成したい場合は、生成されたものを直接コピーできます。例えば、CURL のコードは以下の通りです:
curl -X POST 'https://api.acedata.cloud/identity/bankcard/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "bank_card": "****"
}'
Python の接続コードは以下の通りです:
import requests

url = "https://api.acedata.cloud/identity/bankcard/check-1e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "bank_card": "****"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

エラー処理

API を呼び出す際にエラーが発生した場合、API は対応するエラーコードと情報を返します。例えば:
  • 400 token_mismatched:不正なリクエスト、パラメータが欠落または無効な可能性があります。
  • 400 api_not_implemented:不正なリクエスト、パラメータが欠落または無効な可能性があります。
  • 401 invalid_token:未認証、無効または欠落した認証トークン。
  • 429 too_many_requests:リクエストが多すぎます、レート制限を超えました。
  • 500 api_error:内部サーバーエラー、サーバーで何かがうまくいきませんでした。

エラー応答の例

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "取得に失敗しました"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

結論

この文書を通じて、銀行カード基本情報照会 API を使用して入力された銀行カード番号の基本情報を照会する方法を理解しました。この文書が、API の接続と使用をより良くする手助けとなることを願っています。ご不明な点がございましたら、いつでも技術サポートチームにお問い合わせください。