sunabarはじめてガイド

sunabarの基本

sunabarの基本

sunabarとは、仮想インターネットバンキングで、入出金や振込などを自由にお試しいただける「API 実験場」です。当社口座を保有しているお客さまは、審査なしでご利用が可能なため、個人のお客さま、法人のお客さまでも、当社の銀行APIの開発に取り組むことができます。

sunabar-GMO あおぞらネット銀行 API実験場って何?

サンドボックスを意味する「砂場」と、人が集いグラスを交わす「Bar」を組み合わせ名付けました。この名の通り、「sunabar」は、実際に動かせる開発環境と開発者が集うコミュニティの2面を持ちます。現在世の中に存在するコミュニティは座学やセミナー形式のものが多く、実際に動かして確認できる開発環境は限定的です。No.1テクノロジーバンクを目指す当社は、国内銀行初の試みとして、本格的な銀行API実験環境を「sunabar-GMO あおぞらネット銀行 API実験場-」と名付け、個人・個人事業主・法人のお客さまに開放いたします。また、合わせて開発者が集い、互いに刺激を受け・与えるコミュニティ「sunabar コミュニティ」の運営を行うことで、旧来の金融常識にとらわれず、インターネットの常識から金融に変革を起こすトリガーとなりたいと考えています。

sunabarの概要

sunabarってどんな実験場?

銀行勘定系シミュレータ機を中心とし、APIゲートウェイ、sunabarポータルサイト、sunabarサービスサイトで構成される、銀行API開発支援をするためのサンドボックス環境です。sunabar は全てAWS上で稼動しています。※API仕様に関しては当社Webサイトで提供しているAPI仕様と同様ですが、その他の機能につきましては必ずしも当社Webサイトと同様ではありませんのでご注意ください。

※AWSはAmazon Web Serviceが提供するサービスです。 ※AWSはAmazon Web Service, Inc及びその関連会社の商標です。

APIゲートウェイとは?

当社openAPI機能を模倣したsunabar環境専用API機能です。
利用方法はほぼ当社サービスサイトと同様ですが、影響範囲はsunabar環境下のみとなります。
詳細は利用方法は『sunabar APIについて』をご参照ください。

sunabarポータルサイトとは?

sunabarに関するお知らせを掲載したり、sunabarで利用できる仮想の銀行口座を発行します。また、銀行APIだけでは実現できないATMからの入出金や他行からの振込などをシミュレートする機能を提供します。sunabarポータルサイトでは、疑似的にATMからの入出金や他行振込を行う機能を提供する事で、より現実の世界に近い、リアルな実験環境を提供します。
詳細は利用方法は『sunabarポータルサイトについて』をご参照ください。

sunabarサービスサイトとは?

当社サービスサイトを模倣したsunabar環境専用サイトです。
利用方法はほぼ当社openAPIと同様ですが、影響範囲はsunabar環境下のみとなります。提供機能は残高確認、振込機能やつかいわけ口座機能となります証券コネクト振替や外貨等一部機能は提供しておりません。
詳細は利用方法は『sunabarサービスサイトについて』をご参照ください。

sunabarポータルサイトについて

sunabarポータルサイトへログインする

sunabarポータルサイトへのログイン情報は、当社サービスサイトで確認してください。

手順

  1. 当社サービスサイトへログイン ※ID/PASSはご自身のアカウント情報を利用して下さい。
    https://sso.gmo-aozora.com/b2c/login
  2. サービスサイトTOP画面右上の『お客様情報(申込・設定)』をクリック
  3. 『開発者向け』タブをクリック
  4. sunabar用ID/PASSを確認
  5. ”4”の情報を利用して、sunabarポータルサイトへログイン
    https://portal.sunabar.gmo-aozora.com/login

※法人口座のお客様の場合もログイン後お客様情報の開発者タブにて分かりますので、ご担当の取引責任者の方にお問い合わせください。

sunabarサービスサイトで使える銀行口座とは?

sunabarで利用するサービスサイトアカウントの確認・追加を行う事ができます。

『sunabarサービスサイトで使える銀行口座』一覧画面では、下記確認・操作機能を提供しています。

  1. sunabarサービスサイトの個人/法人のアカウント情報
    ・初期は2口座(個人/法人)
  2. sunabarサービスサイトのアカウント追加機能
    ・sunabarサービスサイトのアカウントは10口座まで追加できます
  3. sunabarサービスサイトへのリンク
    ・個人と法人でログイン画面が異なるので注意
  4. sunabarサービスサイトの個人/法人アカウントのトークン情報(コピー)
    ・sunabarAPIで利用
  5. sunabarサービスサイトの個人/法人アカウントのトークン更新
    ・トークン失効タイミング
    1. ポータルサイト最終ログイン日時から30日以上経過
    ※失効処理は毎日 01:00

入出金シミュレータとは?

sunabar用銀行口座(sunabarサービスサイト)への入出金を簡易的に行う機能です。
※初期時sunabar用銀行口座残高は0円の為、当機能を利用して入金を行ってください。

『入出金シミュレーター』では、下記機能を提供しています。

  1. ATM入金 ※残高増
    ・指定されたsunabar用銀行口座へ指定金額の入金処理を行います。
    ・sunabarサービスサイト上の入金履歴では『ATMセブン』で表示されます。
  2. ATM出金 ※残高減
    ・指定されたsunabar用銀行口座から指定金額の出金処理を行います。
    ・sunabarサービスサイト上の出金履歴では『ATMセブン』で表示されます。
  3. 他行振込 ※残高増
    ・指定されたsunabar用銀行口座へ指定金額の入金処理を行います。
    ・sunabarサービスサイト上の入金履歴では『スナバ タロウ』で表示されます。

sunabarサービスサイトについて

sunabarサービスサイトへログインする

sunabarサービスサイトへのログイン情報は、sunabarポータルサイトで確認してください。
※sunabarポータルサイトの『sunabarサービスサイトで使える銀行口座』画面で確認できます。

個人アカウントと法人アカウントで、ログイン画面が異なります。
個人:https://sso.sunabar.gmo-aozora.com/b2c/login
法人:https://sso.sunabar.gmo-aozora.com/corp/b2c/login

sunabarサービスサイトTOP画面を確認する

sunabarサービスサイトの画面構成は、当社サービスサイトと同様の構成になっています。

※一部機能は利用できません。
・TOP画面中央部に利用口座の残高情報が表示されます。
・左下に入出金履歴が表示されます。
・右下に為替レートが表示されますが、sunabarでは利用する事はありません。

振込機能について

基本的な利用方法は当社サービスサイトと同様ですが、一部操作方法がsunabar用として異なるので注意してください。
・当行口座(sunabar用)への振込

  1. 『sunabarサービスサイトで使える銀行口座』で振込先の支店と口座番号を確認。
    ※振込元と振込先は別の口座を指定してください。
  2. 振込先の支店を選択し、口座番号を入力後、『受取人名の表示』ボタンを押下
  3. 『確認』ボタンを押下
  4. 取引パスワード、及びメールトークンはsunabarサービスサイトのパスワードを入力してください。
  5. 振込振込処理完了です

つかいわけ口座について

こちらも当社サービスサイトのつかいわけ口座と同様の機能になります。
sunabar環境での入出金口座を切り分けて設定する事ができます。
親口座に十分な残高があれば、子口座残高以上の出金が可能です。

sunabar APIについて

sunabar APIは当社open APIの機能をsunabarサービス上で再現した機能として提供しています。
当社open APIと同様に”参照系API”と”更新系API”の2種が用意されています。

・参照系API:預金者の口座残高や入出金明細といった、預金者の口座情報を参照することができるAPIです。
・更新系API:預金者の口座の振込や振替といった、預金者の口座の資金移動が含む取引等ができるAPIです。

sunabar APIのURL構成

https://api.sunabar.gmo-aozora.com/{{type}}/v1/{{api}}
type:(個人)personal / (法人)corporation
api:各種APIのエンドポイント情報は開発者ポータルをご確認ください

sunabar API一覧と各APIの概要

APIの仕様書は、当社open APIと同様の為、下記リンク先のドキュメントをご確認ください。
※利用には別途登録(無料)が必要です
開発者ポータル:https://api.gmo-aozora.com/ganb/developer/api-docs/

カテゴリ API 種別 API 概要
口座 参照系 口座一覧照会 保有する全ての口座情報一覧を照会
残高照会 保有する口座の残高情報を照会
入出金明細照会 指定した円普通預金口座の入出金明細情報を照会
振込入金明細照会 被仕向振込の入金明細情報を照会
振込/振替 参照系 振込状況照会 仕向の振込の履歴・状況の照会
振込依頼結果照会 振込依頼、振込取消依頼の処理状態を照会
振込手数料事前照会 仕向の振込依頼の手数料を事前に照会
振込依頼 仕向の振込依頼の指示
振込取消依頼 振込予約、振込申請の取消依頼を指示
つかいわけ口座間振替 つかいわけ口座間の振替の指示
総合振込 更新系 総合振込状況照会 仕向の総合振込の履歴・状況の照会
総合振込依頼結果照会 総合振込依頼の処理状態を照会
総合振込手数料事前照会 仕向の総合振込依頼の手数料を事前に照会
総合振込依頼 仕向の総合振込依頼の指示
総合振込取消依頼 総合振込予約、総合振込申請の取消依頼を指示
振込入金口座
(バーチャル
口座)
参照系 振込入金口座一覧照会 発行済みの振込入金口座の一覧を照会
振込入金口座入金明細照会 入金口座または振込入金口座を指定し、該当する入金明細を照会
振込入金口座発行 振込入金口座の発行
振込入金口座状態変更 振込入金口座の状態変更(停止・再開・削除)
振込入金口座解約申込 振込入金口座契約の解約申込
※Webhook、及び認証APIは提供しておりません。

sunabar APIの使い方

APIを利用するためには、アクセストークンをsunabarポータルサイトから取得し、プログラムやcurlコマンド等を利用してください。
sunabar APIで利用するアクセストークンはsunabarポータルサイトの“sunabarサービスサイトで使える銀行口座”画面を確認してください。
詳細な仕様手順は『チュートリアル(API初級編)』をご確認ください

curlコマンド実行例

口座一覧API:
https://{{domain_name}}/{{type}}/v1/accounts
domain_name:api.sunabar.gmo-aozora.com
type:personal
curl -X GET \
https://api.sunabar.gmo-aozora.com/personal/v1/accounts \
-H "accept: application/json:charset=UTF-8" \
-H "x-access-token:{{アクセストークン}}"

sunabar API実行例
(振込依頼API)

APIで実行した振込依頼の受付を完了させるには、sunabarサービスサイトにて振込依頼を承認する必要があります。

  1. 利用する口座情報をポータルサイトにて確認します。
    ※今回は個人口座から法人口座への振込例となります。

  2. sunabarポータルサイトでコピーしたアクセストークンを利用してAPIを呼出。

    振込依頼API:
    https://{{domain_name}}/{{type}}/v1/transfer/request
    domain_name:api.sunabar.gmo-aozora.com
    type:personal
    curl -X POST \
     https://api.sunabar.gmo-aozora.com/personal/v1/transfer/request \
     -H "x-access-token: YmZlOGM5NTMwZDMyYTljYjZlNjk5MDg4" \
     -H "Content-Type: application/json;charset=UTF-8" \
     -H "Content-Type: application/json" \
     -d '{
      "accountId": "302010000482",
      "remitterName": "アオゾラ テスト",
      "transferDesignatedDate": "2020-06-16",
      "transferDateHolidayCode": "1",
      "totalCount": "1",
      "totalAmount": "1000",
      "transfers": [
        {
          "itemId": 1,
          "transferAmount": "1000",
          "beneficiaryBankCode": "0398",
          "beneficiaryBankName": "アオゾラ",
          "beneficiaryBranchCode": "111",
          "beneficiaryBranchName": "ホンテン",
          "accountTypeCode": "1",
          "accountNumber": "1234567",
          "beneficiaryName": "カ)アオゾラサンギョウ"
         }
       ]
      }'
    
  3. 振込依頼API呼出 ※成功時のレスポンス

    {
      "accountId": "302010000482"
      ,"resultCode": "2"
      ,"applyNo": "2020061500000011"
    }
    
  4. 振込依頼API実施後、sunabarサービスサイトの”お知らせ”に『メールトークン】を発行しました。
    『(オープンAPI連携-振込)』と言うタイトルのお知らせが追加されます。タイトルのリンクを押下し、お知らせ内容の”取引内容承認ページ”のリンクを押下します。

  5. 取引内容承認ページにて振込内容の確認を行い、”取引パスワード”を入力後、”承認”ボタンを押下します。
    ※sunabarサービスサイトでは“取引パスワード”項目は任意の値としています。

  6. 振込元口座の入出金明細ページに表示し、振込依頼額が出金されていることを確認します。

  7. 振込先口座の入出金明細ページに表示し、振込依頼額が入金されていることを確認します。

sunabar単語帳

  1. サービスサイト
    ・当社本家サイト
    https://sso.gmo-aozora.com/b2c/login
  2. open API
    ・当社open APIサービス
    https://api.gmo-aozora.com/ganb/developer/api-docs/
  3. sunabarポータルサイト
    ・sunabarサービス管理サイト
    https://portal.sunabar.gmo-aozora.com/login
  4. sunabarサービスサイト
    ・sunabar用銀行口座サイト
    https://sso.sunabar.gmo-aozora.com/b2c/login
  5. sunabarAPIゲートウェイ
    ・sunabar用API機能
    api.sunabar.gmo-aozora.com

もっと!sunabarお役立ち情報

sunabar FAQ
https://faq.gmo-aozora.com/faq_list.html?page=1&category=102

sunabarエンジニア向けイベント
2020年4月下旬から四半期に1-2回、エンジニアの皆様向けに当社イベントルームおよびWeb配信にてセミナーイベントを予定しています。詳細が決定しましたらconnpass(https://connpass.com/)等でご案内いたしますので“GMOあおぞら“で検索ください。

sunabarオンラインコミュニティ

https://gmo-sunabar.slack.com