メインコンテンツまでスキップ

SelfPersonalDataService API

自己情報取得APIとの連携機能を利用するには、PocketSign MynaConnect API内に定義されているSelfPersonalDataService APIを使用します。

このAPIは、Connect プロトコルに対応しています。 Connect プロトコルについては Verify APIも参照してください。

このAPIを使用した実装デモアプリケーションを公開しています。利用時にはこちらの実装も参考にしてください。

API概要​

自己情報取得APIとの連携では、以下の5つのAPIを使用します。連携フローによって、一部使用しないAPIがあります。

基本的なAPI呼び出しの流れは以下です。

1. CreateSelfPersonalDataRequestSessionによって、 MynaConnectセッションIDを発行します​

  • 後続のAPIではこのMynaConnectセッションIDを使って、セッションの状態やエンドユーザーの本人確認情報や自己情報の照会結果の取得等を行います
  • また、同時にPocketSign MynaConnectへのリダイレクトさせるURLを発行します
  • このAPIの呼び出しで、エンドユーザーがMynaConnectから事業者のサービスにコールバックしてくるためのURLも指定します

2. 事業者サービスはMynaConnectへのリダイレクトURLにエンドユーザーをブラウザでリダイレクトさせます​

  • MynaConnectにリダイレクト後、MynaConnectはマイナンバーカードの読み取りを含むマイナポータルとの連携処理を行います
  • MynaConnect上でのデータ取得完了後、MynaConnectはCreateSelfPersonalDataRequestSessionで指定された事業者サービスのリダイレクトURIにエンドユーザーをリダイレクトします

3. 事業者サービスはエンドユーザーがMynaConnectからコールバックしてきたら、GetSelfPersonalDataRequestStatusでセッションの状態を確認します​

4. 状態が成功であれば、GetSelfPersonalDataRequestResultで、自己情報を取得します​

  • 事業者サービスは取得した自己情報を使った処理・サービスをエンドユーザーに提供します。
注意

PocketSign MynaConnectはエンドユーザーから取得した個人情報を一時的に保持しますが、GetSelfPersonalDataRequestResult及びGetUserIdentityで事業者サービスがそれらの情報を取得した時に、MynaConnect上から情報は削除されるため、一度取得した情報を再度取得することはできません。

具体的なシーケンスについては、連携フロー別のドキュメントをご覧ください。

詳細なAPI定義はSelfPersonalDataService APIリファレンスを参照してください。

認証​

SelfPersonalDataService APIは、テナントのAPIトークンを用いて認証します。PocketSign Platform上で取得したトークンを、APIへのリクエストの Authorization ヘッダーに以下の形式で指定してください。

Authorization: Bearer <APIトークン>

例:

Authorization: Bearer OHabaTHrbodveeKRwjYePMTPUizcungcERxeIarmnyZMkjrkzLONnuWwcLIXgCDn

APIトークンの作成方法は、こちらをご覧ください。

エラーハンドリング​

注記

このセクションは現在作成中です。

このトピックについて知りたい場合は、お問い合わせください。