APIs de eUICC

No Android 9, as APIs de gerenciamento de perfil (public e @SystemApi) estão disponíveis pela classe EuiccManager. As APIs de comunicação eUICC (somente @SystemApi) estão disponíveis na classe EuiccCardManager.

Sobre o eUICC

As operadoras podem criar apps de operadoras usando o EuiccManager para gerenciar perfis, conforme mostrado na Figura 1. Os apps da operadora não precisam ser apps do sistema, mas precisam ter privilégios de operadora concedidos por perfis eUICC. Um app de LPA (LUI e back-end de LPA) precisa ser um app do sistema (ou seja, incluído na imagem do sistema) para chamar a @SystemApi.

Smartphone Android com app da operadora e LPA do OEM

Figura 1. Smartphones Android com app da operadora e LPA do OEM

Além da lógica de chamar EuiccCardManager e falar com o eUICC, os apps LPA precisam implementar o seguinte:

  • Cliente do SM-DP+ conversando com o servidor SM-DP+ para autenticar e fazer o download de perfis
  • [Opcional] SM-DS para ter mais perfis para download
  • Processamento de notificações para enviar notificações ao servidor e atualizar o estado do perfil
  • [Opcional] Gerenciamento de slots, incluindo a alternância entre a lógica de eSIM e pSIM. Isso é opcional se o smartphone tiver apenas um chip de eSIM.
  • OTA do eSIM

Embora mais de um app LPA possa estar presente em um smartphone Android, apenas um LPA pode ser selecionado para ser o LPA em funcionamento com base na prioridade definida no arquivo AndroidManifest.xml de cada app.

Usar o EuiccManager

As APIs LPA são públicas pelo EuiccManager (no pacote android.telephony.euicc). Um app de operadora pode acessar a instância de EuiccManager e chamar os métodos em EuiccManager para receber as informações de eUICC e gerenciar assinaturas (chamadas de perfis nos documentos RSP do GSMA) como instâncias de SubscriptionInfo.

Para chamar APIs públicas, incluindo operações de download, troca e exclusão de assinatura, o app da operadora precisa ter os privilégios necessários. Os privilégios de operadora são adicionados pela operadora de celular nos metadados do perfil. A API eUICC aplica as regras de privilégio da operadora de acordo.

A plataforma Android não processa as regras da política de perfil. Se uma regra de política for declarada nos metadados do perfil, o LPA poderá escolher como processar o procedimento de download e instalação do perfil. Por exemplo, é possível que um LPA de OEM de terceiros processe regras de política usando um código de erro especial. O código de erro é transmitido do LPA do OEM para a plataforma e, em seguida, a plataforma transmite o código para a LUI do OEM.

Para informações sobre APIs de vários perfis ativados, consulte Vários perfis ativados.

APIs

As APIs abaixo podem ser encontradas na documentação de referência do EuiccManager e em EuiccManager.java.

Acessar instância (público)

Recebe a instância de EuiccManager por Context#getSystemService. Para mais detalhes, consulte getSystemService.

EuiccManager mgr = (EuiccManager) context.getSystemService(Context.EUICC_SERVICE);

Cheque ativado (público)

Verifica se a assinatura incorporada está ativada. Isso deve ser verificado antes de acessar as APIs LPA. Para mais detalhes, consulte isEnabled.

boolean isEnabled = mgr.isEnabled();
if (!isEnabled) {
    return;
}

Receber EID (público)

Recebe o EID que identifica o hardware do eUICC. Ele pode ser nulo se o eUICC não estiver pronto. O autor da chamada precisa ter privilégios de operadora ou a permissão READ_PRIVILEGED_PHONE_STATE. Para mais detalhes, consulte getEid.

String eid = mgr.getEid();
if (eid == null) {
  // Handle null case.
}

Acessar EuiccInfo (público)

Recebe informações sobre o eUICC. Ele contém a versão do SO. Para mais detalhes, consulte getEuiccInfo.

EuiccInfo info = mgr.getEuiccInfo();
String osVer = info.getOsVersion();

Fazer o download da assinatura (público)

Faz o download da assinatura (chamada de "perfil" nos documentos RSP do GSMA). A assinatura pode ser criada com um código de ativação. Por exemplo, um código de ativação pode ser analisado a partir de um QR code. O download de uma assinatura é uma operação assíncrona.

O autor da chamada precisa ter a permissão WRITE_EMBEDDED_SUBSCRIPTIONS ou privilégios da operadora para a assinatura de destino. Para mais detalhes, consulte downloadSubscription.

// Register receiver.
String action = "download_subscription";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE,
                    0 /* defaultValue*/);
                resultIntent = intent;
            }
        };
context.registerReceiver(
        receiver,
        new IntentFilter(action),
        "example.broadcast.permission" /* broadcastPermission*/, null /* handler */);

// Download subscription asynchronously.
DownloadableSubscription sub =
        DownloadableSubscription.forActivationCode(code /* encodedActivationCode*/);
Intent intent = new Intent(action);
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent, PendingIntent.FLAG_UPDATE_CURRENT);
mgr.downloadSubscription(sub, true /* switchAfterDownload */, callbackIntent);

Mudar a assinatura (público)

Muda para (ativa) a assinatura especificada. O autor da chamada precisa ter WRITE_EMBEDDED_SUBSCRIPTIONS ou ter privilégios de operadora para a assinatura ativa atual e a assinatura de destino. Para mais detalhes, consulte switchToSubscription.

// Register receiver.
String action = "switch_to_subscription";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE, 0 /* defaultValue*/);
                resultIntent = intent;
            }
        };
context.registerReceiver(receiver, new IntentFilter(action),
        "example.broadcast.permission" /* broadcastPermission*/, null /* handler */);

// Switch to a subscription asynchronously.
Intent intent = new Intent(action);
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent, PendingIntent.FLAG_UPDATE_CURRENT);
mgr.switchToSubscription(1 /* subscriptionId */, callbackIntent);

Mudar a assinatura com a porta (público)

(Disponível no Android 13) Muda para (ativa) a assinatura especificada com o índice de porta especificado. O autor da chamada precisa ter WRITE_EMBEDDED_SUBSCRIPTIONS ou ter privilégios da operadora para a assinatura ativa atual e a assinatura de destino. Para mais detalhes, consulte switchToSubscription.

// Register receiver.
String action = "switch_to_subscription";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE, 0 /* defaultValue*/);
                resultIntent = intent;
            }
        };
context.registerReceiver(receiver, new IntentFilter(action),
        "example.broadcast.permission" /* broadcastPermission*/, null /* handler */);

// Switch to a subscription asynchronously.
Intent intent = new Intent(action);
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent, PendingIntent.FLAG_UPDATE_CURRENT);
mgr.switchToSubscription(1 /* subscriptionId */, 0 /*portIndex*/, callbackIntent);

Porta do chip disponível (pública)

public boolean isSimPortAvailable(int portIndex)

(Disponível no Android 13) Retorna se o índice de porta de transmissão está disponível. Uma porta estará disponível se não tiver assinatura ativada ou se o app de chamada tiver privilégio de operadora sobre a assinatura instalada na porta selecionada. Para mais detalhes, consulte isSimPortAvailable.

Excluir assinatura (público)

Exclui uma assinatura com um ID. Se a assinatura estiver ativa, ela será desativada primeiro. O autor da chamada precisa ter privilégios de WRITE_EMBEDDED_SUBSCRIPTIONS ou de operadora para a assinatura de destino. Para mais detalhes, consulte deleteSubscription.

// Register receiver.
String action = "delete_subscription";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE,
                    0 /* defaultValue*/);
                resultIntent = intent;
            }
        };
context.registerReceiver(receiver, new IntentFilter(action),
        "example.broadcast.permission" /* broadcastPermission*/,
        null /* handler */);

// Delete a subscription asynchronously.
Intent intent = new Intent(action);
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent, PendingIntent.FLAG_UPDATE_CURRENT);
mgr.deleteSubscription(1 /* subscriptionId */, callbackIntent);

Apagar todas as assinaturas (API do sistema)

Exclui todas as assinaturas de um dispositivo. A partir do Android 11, você precisa fornecer um valor de enumeração EuiccCardManager#ResetOption para especificar se quer apagar todos os tipos de assinaturas de teste, operacionais ou ambos. O autor da chamada precisa ter a permissão WRITE_EMBEDDED_SUBSCRIPTIONS.

// Register receiver.
String action = "delete_subscription";
BroadcastReceiver receiver =
        new BroadcastReceiver() {
            @Override
            public void onReceive(Context context, Intent intent) {
                if (!action.equals(intent.getAction())) {
                    return;
                }
                resultCode = getResultCode();
                detailedCode = intent.getIntExtra(
                    EuiccManager.EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE,
                    0 /* defaultValue*/);
                resultIntent = intent;
            }
        };
context.registerReceiver(receiver, new IntentFilter(action),
        "example.broadcast.permission" /* broadcastPermission*/,
        null /* handler */);

// Erase all operational subscriptions asynchronously.
Intent intent = new Intent(action);
PendingIntent callbackIntent = PendingIntent.getBroadcast(
        getContext(), 0 /* requestCode */, intent, PendingIntent.FLAG_UPDATE_CURRENT);
mgr.eraseSubscriptions(
        EuiccCardManager.RESET_OPTION_DELETE_OPERATIONAL_PROFILES, callbackIntent);

Iniciar atividade de resolução (público)

Inicia uma atividade para resolver um erro que o usuário pode resolver. Se uma operação retornar EuiccManager#EMBEDDED_SUBSCRIPTION_RESULT_RESOLVABLE_ERROR, esse método poderá ser chamado para solicitar que o usuário resolva o problema. Esse método só pode ser chamado uma vez para um erro específico.

...
mgr.startResolutionActivity(getActivity(), 0 /* requestCode */, resultIntent, callbackIntent);

Constantes

Para conferir uma lista das constantes public em EuiccManager, consulte Constantes.