プレビュー版
PocketSign Link v2 は現在プレビュー版です。正式提供までに仕様が変更される可能性があります。
環境
PocketSign Link v2 では、KLON システムのポケットサイン開発環境・テスト環境・本番環境の三種類の環境を用意しています。 環境の違いは PocketSign Link と同様で、それぞれ利用するカードや証明書体系が異なります。
環境ごとの違い
| 使用するカード | 利用料金 | 詳細 | |
|---|---|---|---|
| ポケットサイン開発環境 | FeliCa カード(交通系 IC カード、Edy、WAON など)や、ISO/IEC 14443-4 Type-A カード(クレジットカードなど) | 無料 | ポケットサイン社が運用するモック認証局が発行した証明書を利用する環境です。 |
| テスト環境 | J-LIS が発行するテスト用マイナンバーカード | 無料 | JPKI テスト認証局が発行した証明書を利用する環境です。 |
| 本番環境 | 実際のマイナンバーカード | 有料 | 公的個人認証サービスが発行した証明書を利用する環境です。 |
動作確認にはポケットサイン開発環境を使用し、実際のサービス提供は本番環境で行うことを想定しています。 ポケットサイン開発環境でのマイナンバーカード認証には、実際のマイナポータルアプリの代わりに開発環境 認証アプリを使用します。
接続先
PocketSign Link v2 の API は、KLON システムの IdP と Registry を通じて環境ごとにそれぞれ別オリジンで提供されます。
| 環境 | IdP | Registry |
|---|---|---|
| ポケットサイン開発環境 | https://id.mock.klon.you | https://registry.mock.klon.you |
| テスト環境 | https://id.test.klon.you | https://registry.test.klon.you |
| 本番環境 | https://id.klon.you | https://registry.klon.you |
OIDC エンドポイントの見方
このガイドの各ページで記載している OIDC のエンドポイントパスは、すべて IdP サーバーのオリジン配下で提供されています。
たとえばポケットサイン開発環境では、次のように読み替えます。
| 用途 | パス | 実際の URL |
|---|---|---|
| Discovery | /.well-known/openid-configuration | https://id.mock.klon.you/.well-known/openid-configuration |
| 認可エンドポイント | /api/oidc/v1/authorize | https://id.mock.klon.you/api/oidc/v1/authorize |
| PAR | /api/oidc/v1/par | https://id.mock.klon.you/api/oidc/v1/par |
| トークン | /api/oidc/v1/token | https://id.mock.klon.you/api/oidc/v1/token |
| UserInfo | /api/oidc/v1/userinfo | https://id.mock.klon.you/api/oidc/v1/userinfo |
| Introspection | /api/oidc/v1/introspect | https://id.mock.klon.you/api/oidc/v1/introspect |
| Revocation | /api/oidc/v1/revoke | https://id.mock.klon.you/api/oidc/v1/revoke |
| JWKS | /api/oidc/v1/jwks | https://id.mock.klon.you/api/oidc/v1/jwks |
ポケットサイン開発環境や本番環境でも、ホスト名の違いを除けば同じパス構成です。
Registry API の見方
Registry API は Registry サーバーのオリジン配下で、Connect プロトコルの RPC パスとして提供されます。
たとえばポケットサイン開発環境では、次のように読み替えます。
| 用途 | パス | 実際の URL |
|---|---|---|
| User API の読み取り | /pocketsign.link.v2.RegistryUserService/ReadResourceValue | https://registry.mock.klon.you/pocketsign.link.v2.RegistryUserService/ReadResourceValue |
| User API の書き込み | /pocketsign.link.v2.RegistryUserService/WriteResourceValue | https://registry.mock.klon.you/pocketsign.link.v2.RegistryUserService/WriteResourceValue |
| Client API の読み取り | /pocketsign.link.v2.RegistryClientService/ReadResourceValue | https://registry.mock.klon.you/pocketsign.link.v2.RegistryClientService/ReadResourceValue |
| Client API の書き込み | /pocketsign.link.v2.RegistryClientService/WriteResourceValue | https://registry.mock.klon.you/pocketsign.link.v2.RegistryClientService/WriteResourceValue |
接続先を扱うときの注意
- OIDC の接続先は固定文字列で埋め込まず、環境ごとの
IdPオリジンを設定として持つのが安全です issuerや各エンドポイントは、まず/.well-known/openid-configurationを取得して確認してください