当社システムとのAPI接続を検討される事業者さま(法人)が、当社が提供するAPIの仕様を確認することができるポータルサイトです。

導入検討にあたっての契約締結が完了した事業者さまにポータルへのログイン権限を付与させていただきます。また、本ポータルサイトのご利用にあたってはAPI開発者ポータル同意事項への同意が必要です。

■対象のお客さま

 当社は基本方針に基づき、様々な企業との連携及び協働を進めていくことで、より利便性の高い社会の実現に努めてまいります。

そのため、当社とのAPI接続にあたっては、事業としてサービスを展開している事業者さま(法人)に限ります。

ホーム画面または画面上部のAPIタブから個人口座向けAPI、法人口座向けAPIを選択し、仕様をご参照ください。

APIの仕様ページのAPI definitionボタンを押下することで、ダウンロードできます。(JSON形式)
APIの仕様はSwagger2.0で記述しています。

トライアル環境の利用、API仕様書などの参照にはアカウントが必要です。
アカウントの作成タイミングについては導入時における面談後にご案内させていただきます。法人のお客さまに限定させていただいております。
アカウント登録完了後、メールにて登録完了のお知らせをお送りしたのちログオン可能となります。

アカウント登録後ログオンすることで、トライアル環境を利用することができます。
本ポータルサイトからの接続の他、事業者さま環境からのリクエストも可能です。レスポンスデータのパターンについては次項をご参照ください。
なお、本トライアル環境は認可には対応しておりません。リクエストする際のトークンはデータパターン一覧に記載のトークンを指定してください。APIのエンドポイントはAPIの仕様ページに記載しています。

アカウント登録後、ログオンすることでAPI仕様書などが参照可能になります。
APIページからご確認ください。

  • API仕様書・・・API方式設計、本番環境の利用前提

  • チェック仕様書・・・APIごとのエラー仕様詳細一覧

  • テストデータ一覧・・・トライアル環境で使用できるリクエスト、レスポンスデータの一覧