外部システムとJPYC Gatewayを連携|APIキー管理機能とは
法人でステーブルコインの利用が増えてくると、JPYC Gatewayの画面から一つひとつ操作するだけではなく、既存の業務システムと連携したい場面も増えてきます。
例えば、会計システムからウォレット残高を取得したい、基幹システムに入出金履歴を取り込みたい、自社システムから送金処理を登録したい、といったケースです。
JPYC Gatewayでは、こうした外部システムとの連携に利用する「APIキー」を発行・管理できます。
目次
1. APIキーとは?
APIキーは、お客様の業務システムからJPYC Gatewayの機能を呼び出すために使用する認証情報です。
JPYC GatewayのAPIでは、主に以下の操作を行えます。
- 自社ウォレット、送金先ウォレットの一覧や残高の取得
- 入出金履歴の取得
- 送金の作成
- 送金キューへの登録、取消
例えば、自社の会計システムからJPYC Gatewayの入出金履歴を取得したり、基幹システムで発生した支払情報をもとに送金を登録したりする仕組みを構築できます。
人がJPYC Gatewayの画面を開いて確認・入力するだけでなく、自社の業務フローの中にステーブルコイン関連の処理を組み込めるようになります。
2. APIキーはどのように発行するのか
APIキーは、JPYC Gatewayの「APIキー管理」画面から発行します。
新しいAPIキーを作成する際には、用途を判別するためのラベルや説明を設定できます。
例えば、「基幹システム連携用」「会計システム連携用」といった名称を付けておけば、複数のAPIキーを利用している場合でも、それぞれの用途を把握しやすくなります。
また、APIキーには有効期限を設定できます。設定可能な期間は次のとおりです。
- 無期限
- 30日
- 90日
- 180日
- 1年
利用目的に合わせて有効期限を設けることで、利用されなくなったAPIキーがそのまま残り続けることを避けやすくなります。
3. 接続元IPアドレスを制限することも可能
APIキーを発行する際には、APIを利用できる接続元IPアドレスを指定できます。
IPアドレスまたはCIDR形式で登録でき、IPv6にも対応しています。
例えば、社内システムや特定のサーバーからのみJPYC GatewayのAPIを利用する運用であれば、その接続元を登録しておくことができます。
接続元IPアドレスを設定しない場合は、IPによる制限は行われません。
そのため、実際のシステム構成や運用方針に合わせて設定を検討することが重要です。
4. 外部システムごとにAPIキーを分けて管理
JPYC Gatewayでは、1つのテナントにつき最大5個までAPIキーを発行できます。
複数の外部システムと連携する場合には、1つのAPIキーを共通利用するのではなく、システムごとに別々のAPIキーを発行することが推奨されています。
例えば、会計システム用、基幹システム用、社内決済システム用といった形で分けて管理します。
APIキーをシステムごとに分けておけば、あるシステムで利用しているAPIキーを停止する必要が生じた場合でも、そのキーだけを無効化できます。
他のシステムで使用しているAPIキーまで変更する必要がないため、外部連携を管理しやすくなります。
5. APIキーのアクセス範囲には注意が必要
JPYC GatewayのAPIキーを利用するうえで、特に重要なのがアクセス範囲です。
現在の仕様では、APIキーごとに「残高照会だけ」「入出金履歴だけ」といった機能単位のアクセス範囲を設定する仕組みはありません。
発行されたAPIキーは、そのテナントで利用できるAPI機能すべてにアクセスできます。
また、JPYC Gatewayの画面上で設定するロール権限やウォレット別アクセス権限も、APIリクエストには適用されません。
そのため、APIキーそのものを適切に管理するとともに、「APIキー管理」の権限を誰に付与するかをあらかじめ設計することが重要です。
APIキーの発行・無効化・削除には、全体機能権限の「APIキー管理」が必要です。
例えば、テナント管理者など必要な担当者に限定して、この権限を付与するといった運用が考えられます。
6. APIキーとシークレットキーは発行時のみ表示
APIキーを作成すると、「APIキー」と「シークレットキー」の2つが発行されます。
これらは発行時の画面でのみ確認できます。
一度画面を閉じるとJPYC Gateway上から再表示することはできないため、発行直後に必要な情報を控え、適切な場所で管理する必要があります。
紛失した場合は、既存のキーを復元するのではなく、新しいAPIキーを発行し直します。
API連携を運用する際には、発行したキーをどこで管理するのかについても、事前にルールを決めておくことが重要です。
7. 不要になったAPIキーは無効化・削除
外部システムとの連携が終了した場合や、APIキーが不要になった場合には、JPYC GatewayからAPIキーを無効化または削除できます。
「無効化」を行うと、そのAPIキーを使用したAPIリクエストは拒否されるようになります。無効化したAPIキーは一覧には残るため、作成日や最終使用日時などを後から確認できます。
一方、「削除」を行うと、APIキーの登録自体が削除され、一覧からも表示されなくなります。
APIキー管理画面では最終使用日時を確認できるため、長期間利用されていないAPIキーが残っていないか定期的に確認し、不要なものを整理するといった運用にも活用できます。
8. 法人利用では「API連携」と「APIキー管理」をセットで考える
APIを利用すれば、JPYC Gatewayを企業の既存システムと連携できます。
例えば、次のような業務フローを構築することもできます。
また、会計システムから残高や入出金履歴を取得することで、JPYC Gateway上の情報を社内業務へ取り込むことも可能です。
一方で、APIキーはJPYC Gatewayの機能を外部システムから利用するための認証情報です。そのため、単にAPIを導入するだけでなく、次のような運用ルールまで含めて考えることが重要です。
- 誰がAPIキーを発行できるのか
- どのシステムでどのAPIキーを使用するのか
- 有効期限をどう設定するのか
- 接続元IPを制限するのか
- 不要になったキーをどう管理するのか
9. まとめ
JPYC GatewayのAPIキー管理機能を利用することで、自社の会計システムや基幹システムなどからJPYC Gatewayの機能を呼び出せるようになります。
ウォレットや残高の取得、入出金履歴の取得、送金登録などを既存システムと連携することで、ステーブルコインに関する業務を自社の業務フローへ組み込むことが可能になります。
同時に、APIキーには有効期限や接続元IP制限を設定でき、不要になったキーは無効化・削除できます。
ステーブルコインの利用が増えていくほど、画面上の操作だけでなく、既存システムとの連携も重要になります。
APIキー管理は、JPYC Gatewayと企業の業務システムをつなぎ、ステーブルコインをより実務に組み込んでいくための機能です。
赤松 智彦
アステリア株式会社 / ステーブルコイン事業部
システム連携やデータ活用の知見から、企業の「財務DX」や「デジタル通貨のビジネス活用」をテーマに、日本円ステーブルコインの普及に向けた実務ノウハウや最新トレンドなどのお役立ち情報をお届けします。