Wydawanie cyfrowych dokumentów tożsamości

Interfejs Credential Manager API umożliwia wydawanie dokumentów aplikacjom na Androida, które przechowują dokumenty (nazywanym też „portfelem”). Z tego przewodnika dowiesz się, jak zapisywać dane logowania w ulubionym portfelu użytkownika.

Implementacja

W tej sekcji znajdziesz szczegółowe informacje o krokach, które należy wykonać, aby wydać cyfrowe dokumenty tożsamości.

Dodawanie zależności

Dodaj do skryptu kompilacji Gradle te zależności:

Kotlin

dependencies {
    implementation("androidx.credentials:credentials:1.7.0-alpha02")
    implementation("androidx.credentials:credentials-play-services-auth:1.7.0-alpha02")
}

Groovy

dependencies {
    implementation "androidx.credentials:credentials:1.7.0-alpha02"
    implementation "androidx.credentials:credentials-play-services-auth:1.7.0-alpha02"
}

Inicjowanie Credential Manager API

Zainicjuj instancję klasy CredentialManager.

val credentialManager = CredentialManager.create(context)

Tworzenie prośby o wydanie

Żądanie utworzenia cyfrowego dokumentu tożsamości powinno zawierać ciąg znaków JSON zgodny ze standardowym protokołem OpenID4VCI. Oto przykład żądania OpenID4VCI:

"requests": [
  {
    "protocol": "openid4vci-v1",
    "data": {
      "credential_issuer": "https://digital-credentials.dev",
      "credential_configuration_ids": [
        "com.emvco.payment_card"
      ],
      "grants": {
        "urn:ietf:params:oauth:grant-type:pre-authorized_code": {
          "pre-authorized_code": "..."
        }
      }
    }
  }
]

Utwórz CreateDigitalCredentialRequest, który zawiera prośbę o wydanie.

val issuanceRequestJson = "{ ... }" // Your issuance JSON
val createRequest = CreateDigitalCredentialRequest(
    requestJson = issuanceRequestJson,
    origin = null
)

Przesyłanie prośby o wydanie

Wydaj dane logowania posiadaczowi użytkownika za pomocą funkcji createCredential. Ta funkcja uruchamia selektor planszy dolnej Credential Manager, który umożliwia użytkownikowi wybranie aplikacji przechowującej, w której mają być przechowywane dane logowania.

try {
    val response = credentialManager.createCredential(
        context = context,
        request = createRequest
    )
    handleSuccess(response as CreateDigitalCredentialResponse)
} catch (e: CreateCredentialException) {
    handleCreateException(e)
}

Obsługa odpowiedzi

Po przesłaniu prośby o wydanie zwrócimy CreateDigitalCredentialResponse. Odpowiedź zawiera ciąg znaków responseJson, który opisuje wynik wydania.

fun handleSuccess(response: CreateDigitalCredentialResponse) {
    val responseJson = response.responseJson
    // Parse responseJson according to your protocol (e.g. OpenID4VCI)
}

Obsługa wyjątków

Jeśli proces wydawania się nie powiedzie, createCredential zgłosi wyjątek CreateCredentialException, który Twoja aplikacja powinna obsłużyć:

fun handleCreateException(e: CreateCredentialException) {
    when (e) {
        is CreateCredentialCancellationException -> {
            // The user canceled the flow
        }
        is CreateCredentialInterruptedException -> {
            // The flow was interrupted (e.g. by another UI element)
        }
        is CreateCredentialNoCreateOptionException -> {
            // No wallet application is available to handle the request
        }
        is CreateCredentialUnsupportedException -> {
            // The device or the system doesn't support this request
        }
        is CreateCredentialProviderConfigurationException -> {
            // There is a configuration issue with the wallet provider
        }
        is CreateCredentialCustomException -> {
            // A protocol-specific error occurred
            val errorType = e.type
            val errorMessage = e.message
        }
        is CreateCredentialUnknownException -> {
            // An unknown error occurred
        }
        else -> {
            // Generic error handling
        }
    }
}