SDK のセットアップ

各カードからデータを読み出すためには、それぞれに対応した SDK が必要になります。

iOS

iOS アプリへの SDK 組み込みを参考に、下記のパッケージを追加してください。

Swift Package Manager

Xcodeで下記のパッケージを追加してください。

モック環境

• 共通して必要
  • https://repo.platform.p8n.app/VerifyBaseMock/
  • https://repo.platform.p8n.app/VerifyBaseShared/
• 運転免許証から読み出す場合に必要
  • https://repo.platform.p8n.app/VerifyDriversLicenseMock/
  • https://repo.platform.p8n.app/VerifyDriversLicenseShared/
• 在留カードから読み出す場合に必要
  • https://repo.platform.p8n.app/VerifyResidenceCardMock/
  • https://repo.platform.p8n.app/VerifyResidenceCardShared/
• マイナンバーカードの券面系APから読み出す場合に必要
  • https://repo.platform.p8n.app/VerifyCardInfoMock/
  • https://repo.platform.p8n.app/VerifyCardInfoShared/

テスト環境/本番環境

注意

この設定はテスト環境/本番環境用です。開発中はモック環境を利用してください。 環境の違いについては、環境をご覧ください。

• 共通して必要
  • https://repo.platform.p8n.app/VerifyBase/
  • https://repo.platform.p8n.app/VerifyBaseShared/
• 運転免許証から読み出す場合に必要
  • https://repo.platform.p8n.app/VerifyDriversLicense/
  • https://repo.platform.p8n.app/VerifyDriversLicenseShared/
• 在留カードから読み出す場合に必要
  • https://repo.platform.p8n.app/VerifyResidenceCard/
  • https://repo.platform.p8n.app/VerifyResidenceCardShared/
• マイナンバーカードの券面系APから読み出す場合に必要
  • https://repo.platform.p8n.app/VerifyCardInfo/
  • https://repo.platform.p8n.app/VerifyCardInfoShared/

CocoaPods

Podsfileに下記を追加してください。

モック環境

# 共通して必要
pod 'VerifyBaseMock', :git => 'https://repo.platform.p8n.app/VerifyBaseMock/'
pod 'VerifyBaseShared', :git => 'https://repo.platform.p8n.app/VerifyBaseShared/'

# 運転免許証から読み出す場合に必要
pod 'VerifyDriversLicenseMock', :git => 'https://repo.platform.p8n.app/VerifyDriversLicenseMock/'
pod 'VerifyDriversLicenseShared', :git => 'https://repo.platform.p8n.app/VerifyDriversLicenseShared/'

# 在留カードから読み出す場合に必要
pod 'VerifyResidenceCardMock', :git => 'https://repo.platform.p8n.app/VerifyResidenceCardMock/'
pod 'VerifyResidenceCardShared', :git => 'https://repo.platform.p8n.app/VerifyResidenceCardShared/'

# マイナンバーカードの券面系APから読み出す場合に必要
pod 'VerifyCardInfoMock', :git => 'https://repo.platform.p8n.app/VerifyCardInfoMock/'
pod 'VerifyCardInfoShared', :git => 'https://repo.platform.p8n.app/VerifyCardInfoShared/'

テスト環境/本番環境

注意

この設定はテスト環境/本番環境用です。開発中はモック環境を利用してください。 環境の違いについては、環境をご覧ください。

# 共通して必要
pod 'VerifyBase', :git => 'https://repo.platform.p8n.app/VerifyBase/'
pod 'VerifyBaseShared', :git => 'https://repo.platform.p8n.app/VerifyBaseShared/'

# 運転免許証から読み出す場合に必要
pod 'VerifyDriversLicense', :git => 'https://repo.platform.p8n.app/VerifyDriversLicense/'
pod 'VerifyDriversLicenseShared', :git => 'https://repo.platform.p8n.app/VerifyDriversLicenseShared/'

# 在留カードから読み出す場合に必要
pod 'VerifyResidenceCard', :git => 'https://repo.platform.p8n.app/VerifyResidenceCard/'
pod 'VerifyResidenceCardShared', :git => 'https://repo.platform.p8n.app/VerifyResidenceCardShared/'

# マイナンバーカードの券面系APから読み出す場合に必要
pod 'VerifyCardInfo', :git => 'https://repo.platform.p8n.app/VerifyCardInfo/'
pod 'VerifyCardInfoShared', :git => 'https://repo.platform.p8n.app/VerifyCardInfoShared/'

パッケージを追加したら、下記のようにインポートしてください。

/* ... */

// 共通して必要
import VerifyBaseMock
import VerifyBaseShared

// 運転免許証から読み出す場合に必要
import VerifyDriversLicenseMock
import VerifyDriversLicenseShared

// 在留カードから読み出す場合に必要
import VerifyResidenceCardMock
import VerifyResidenceCardShared

// マイナンバーカードの券面系APから読み出す場合に必要
import VerifyCardInfoMock
import VerifyCardInfoShared

func run(pin: String) async throws -> String {
  // カードへの接続準備を行います。
  let session = ReaderSession(dispatchQueue: DispatchQueue.main)

  // ここに実装を追加します。

  session.close()
  return "not implemented"
}

/* ... */

Android

Android アプリへの SDK 組み込みを参考に、下記のパッケージを追加してください。

libs.versions.toml に下記を追加してください。

モック環境

# 共通して必要
pocketsign-verify-base = { group = "jp.co.pocketsign.verify", name = "base-mock", version.ref = "pocketsign-verify" }
pocketsign-verify-base-shared = { group = "jp.co.pocketsign.verify", name = "base-shared", version.ref = "pocketsign-verify" }

# 運転免許証から読み出す場合に必要
pocketsign-verify-driverslicense = { group = "jp.co.pocketsign.verify", name = "driverslicense-mock", version.ref = "pocketsign-verify" }
pocketsign-verify-driverslicense-shared = { group = "jp.co.pocketsign.verify", name = "driverslicense-shared", version.ref = "pocketsign-verify" }

# 在留カードから読み出す場合に必要
pocketsign-verify-residencecard = { group = "jp.co.pocketsign.verify", name = "residencecard-mock", version.ref = "pocketsign-verify" }
pocketsign-verify-residencecard-shared = { group = "jp.co.pocketsign.verify", name = "residencecard-shared", version.ref = "pocketsign-verify" }

# マイナンバーカードの券面系APから読み出す場合に必要
pocketsign-verify-cardinfo = { group = "jp.co.pocketsign.verify", name = "cardinfo-mock", version.ref = "pocketsign-verify" }
pocketsign-verify-cardinfo-shared = { group = "jp.co.pocketsign.verify", name = "cardinfo-shared", version.ref = "pocketsign-verify" }

テスト環境/本番環境

注意

この設定はテスト環境/本番環境用です。開発中はモック環境を利用してください。 環境の違いについては、環境をご覧ください。

# 共通して必要
pocketsign-verify-base = { group = "jp.co.pocketsign.verify", name = "base", version.ref = "pocketsign-verify" }
pocketsign-verify-base-shared = { group = "jp.co.pocketsign.verify", name = "base-shared", version.ref = "pocketsign-verify" }

# 運転免許証から読み出す場合に必要
pocketsign-verify-driverslicense = { group = "jp.co.pocketsign.verify", name = "driverslicense-mock", version.ref = "pocketsign-verify" }
pocketsign-verify-driverslicense-shared = { group = "jp.co.pocketsign.verify", name = "driverslicense-shared", version.ref = "pocketsign-verify" }

# 在留カードから読み出す場合に必要
pocketsign-verify-residencecard = { group = "jp.co.pocketsign.verify", name = "residencecard-mock", version.ref = "pocketsign-verify" }
pocketsign-verify-residencecard-shared = { group = "jp.co.pocketsign.verify", name = "residencecard-shared", version.ref = "pocketsign-verify" }

# マイナンバーカードの券面系APから読み出す場合に必要
pocketsign-verify-cardinfo = { group = "jp.co.pocketsign.verify", name = "cardinfo-mock", version.ref = "pocketsign-verify" }
pocketsign-verify-cardinfo-shared = { group = "jp.co.pocketsign.verify", name = "cardinfo-shared", version.ref = "pocketsign-verify" }

build.gradle.kts の dependencies に以下のように依存関係を追加します。

plugins {
  /* ... */
}

android {
  /* ... */
}

dependencies {
  /* ... */

  // 共通して必要
  implementation(libs.pocketsign.verify.base)
  implementation(libs.pocketsign.verify.base.shared)

  // 運転免許証から読み出す場合に必要
  implementation(libs.pocketsign.verify.driverslicense)
  implementation(libs.pocketsign.verify.driverslicense.shared)

  // 在留カードから読み出す場合に必要
  implementation(libs.pocketsign.verify.residencecard)
  implementation(libs.pocketsign.verify.residencecard.shared)

  // マイナンバーカードの券面系APから読み出す場合に必要
  implementation(libs.pocketsign.verify.cardinfo)
  implementation(libs.pocketsign.verify.cardinfo.shared)
}

その後、使用するクラスを下記のようにインポートしてください。

モック環境

/* ... */

// 共通して必要
import jp.co.pocketsign.verify.mock.reader.ReaderSession

// 運転免許証から読み出す場合に必要
import jp.co.pocketsign.verify.mock.driverslicense.DriversLicense

// 在留カードから読み出す場合に必要
import jp.co.pocketsign.verify.mock.residencecard.ResidenceCard

// マイナンバーカードの券面系APから読み出す場合に必要
import jp.co.pocketsign.verify.mock.cardinfo.InputSupportAP
import jp.co.pocketsign.verify.mock.cardinfo.ConfirmationAP

class MainActivity : ComponentActivity() {

  suspend fun run(pin: String): String {
    // 運転免許証への接続準備を行います。
    val session = ReaderSession(this, this)

    // ここに実装を追加します。

    session.close()
    return "not implemented"
  }

  /* ... */
}

テスト環境/本番環境

注意

この設定はテスト環境/本番環境用です。開発中はモック環境を利用してください。 環境の違いについては、環境をご覧ください。

/* ... */

// 共通して必要
import jp.co.pocketsign.verify.reader.ReaderSession

// 運転免許証から読み出す場合に必要
import jp.co.pocketsign.verify.driverslicense.DriversLicense

// 在留カードから読み出す場合に必要
import jp.co.pocketsign.verify.residencecard.ResidenceCard

// マイナンバーカードの券面系APから読み出す場合に必要
import jp.co.pocketsign.verify.cardinfo.InputSupportAP
import jp.co.pocketsign.verify.cardinfo.ConfirmationAP

class MainActivity : ComponentActivity() {

  suspend fun run(pin: String): String {
    // 運転免許証への接続準備を行います。
    val session = ReaderSession(this, this)

    // ここに実装を追加します。

    session.close()
    return "not implemented"
  }

  /* ... */
}

Web（PaSoRi）

準備中

Web（PaSoRi）での運転免許証データの読み出し機能は現在準備中です。

Flutter

準備中

Flutter での運転免許証データの読み出し機能は現在準備中です。

React Native

準備中

React Native での運転免許証データの読み出し機能は現在準備中です。