バージョン6.xの変更点#
エラーレスポンスパラメータをerror_descriptionのみに統一しました。
一部のリクエスト/レスポンスにおいて、パラメータ名を下記の使い分けに従い変更しました。
CallbackとRedirectは、どちらも特定の処理後に別の場所へ遷移するという点で似ていますが、次の定義を設け、使い分けております。Redirect:あるURLから別のURLへブラウザを直接移動させる際に使用。
Callback:特定の処理(認証など)が完了した後に、元の場所(クライアント)に結果を通知する際に使用。
バージョン5.x以前:/pittari/callback/request
バージョン6.x以降:/pittari/redirect/request
バージョン5.x以前:client_redirect_url
バージョン6.x以降:redirect_url
※機能・動作に変更はありません。
本APIを使用することで、マイナポータルを利用する利用者が、xIDで公的個人認証を実施できるようになります。対象となる署名値が複数存在する場合は、一括で署名を付します。JPKIやJPKIStatusの仕様とは異なり、本APIにおいては、xIDによる署名検証は実施せず、署名値や証明書を直接返却します。 そのため、マイナンバーカードの電子証明書の状態(有効・失効・有効期限切れ)の確認や基本四情報による利用者当人であることの確認は行いません。必要に 応じて、クライアントでの検証を行ってください。
本APIは以下のエンドポイントで構成されています。JPKIPittariについて#
シーケンス#
利用者フロー#
JPKIPittariRedirectについて#
JPKIPittariとの違い#
JPKIPittariとの違いは主に下記の3点です。本エンドポイントを用いてマイナポータル向け公的個人認証を実施した場合、自動的にxIDアプリへ遷移して公的個人認証が開始されます。
当該認証が完了した後、本リクエストを実行したクライアントアプリに自動的に戻ります。
xIDアプリからの自動遷移先はデフォルトブラウザとなります(特定のアプリへ遷移させたい場合の対策は下記のNoteを参照)。
特定のアプリへ遷移が必要な場合は、JPKIPittariRedirectリクエストのパラメータであるcallback_urlにクライアントアプリのユニバーサルリンクまたはアプリリンクを指定することをご検討ください。
リクエスト元からxIDアプリへの自動遷移#
レスポンスに含まれるredirect_urlを呼び出していただくことで、xIDアプリに自動遷移し、公的個人認証が開始されます。xIDアプリからリクエスト元への自動遷移#
公的個人認証の手続き終了後は、リクエスト時に指定されたURLへ自動遷移いたします。その際、当該手続きのステータス(succeeded, canceled)が付与されますので、ステータスに応じてリクエスト元でクライアントに表示する画面を制御することができます。なお、本エンドポイントでは、署名データなどの送信先(callback_url)と、利用者の画面遷移先(redirect_url)が独立しています。データは callback_url へ送信され、利用者の画面は redirect_url へ遷移します。シーケンス#
利用者フロー#