Componente principal

É o componente mais importante do SDK, pois contém as bibliotecas necessárias para que tudo funcione corretamente.

A instalação do Core Plugin é obrigatória, independentemente dos produtos que sejam necessários utilizar e do caso de uso que tenha sido definido. Contém funcionalidades básicas para o funcionamento do SDK, além de outras funcionalidades transversais e necessárias para os plugins auxiliares.

Dependências

Flutter:

dependencies:
  fphi_sdkmobile_core:
    hosted:
      name: fphi_sdkmobile_core
      url: https://facephicorp.jfrog.io/artifactory/api/pub/pub-pro-fphi/
    version: ^<versão>

Android - Gradle:

api "com.facephi.androidsdk:sdk:$version"
api "com.facephi.androidsdk:core:$version"
implementation "com.facephi.androidsdk:tracking_component:$version"

iOS - CocoaPods:

s.dependency 'FPHISDKMainComponent', '~> $version'
s.dependency 'FPHISDKTrackingComponent', '~> $version'
s.dependency 'FPHISDKLicensingComponent', '~> $version'
s.dependency 'FPHISDKTokenizeComponent', '~> $version'
s.dependency 'FPHISDKStatusComponent', '~> $version'

Métodos disponíveis

Este componente contém vários métodos que executam diferentes funcionalidades:

Método	Descrição
initSession	Controlador principal do componente, responsável por validar as licenças, entre outras coisas.
initOperation	Método encarregado de gerar uma nova operação. O ID dela é recuperado no objeto de resultado, parâmetro data.
getExtraData	O método getExtraData permite gerar os identificadores necessários para uma operação que deva continuar no Serviço de Validações da Facephi (Backend).
closeSession	Antes que a aplicação seja destruída, a sessão do SDK deverá ser encerrada para avisar à plataforma sobre sua finalização.

initSession

Antes de poder utilizar qualquer componente, a sessão do SDK deverá ser inicializada. Essa inicialização deve ser feita o mais cedo possível, preferencialmente no início da aplicação. Ao mesmo tempo, uma vez concluídas todas as operações com o SDK Mobile, a sessão também deverá ser encerrada.

É possível inicializar o componente atual de duas formas, dependendo de como você deseja injetar a licença.

O novo método de licenciamento permite gerenciar as licenças de forma transparente para o integrador. A licença pode ser injetada de duas maneiras:

• Obtendo a licença por meio de um serviço via uma URL e API-KEY

• Injetando a licença diretamente como String

Em ambos os casos, o resultado será retornado por meio de uma Promise, a qual contém um objeto da classe CoreResult.

@override
Future<Map> initSession({ required CoreConfigurationInitSession widgetConfigurationJSON }) async {
  final Map res = await methodChannel.invokeMethod('initSession', {"widgetConfigurationJSON": widgetConfigurationJSON.toJson()});
  return res;
}

Configuração básica

Para iniciar o componente atual, deverá ser criado um objeto CoreConfigurationInitSession que será a configuração do controlador do componente.

A configuração básica necessária é a seguinte:

class CoreConfigurationInitSession
{
  String mLicenseUrl;
  String mLicenseApiKey;
  String mLicense;
  String? mLocale;
  bool? mEnableTracking;
  bool? mEnableDebugMode;
  dynamic mInternalOptions
}

Configuração avançada do componente

A seguir, são detalhados todos os campos que fazem parte desta classe.

Configuração do Init Session

---

initOperation

Ao iniciar um processo ou fluxo, sempre deverá ser feita a chamada ao método initOperation

@override
Future<Map> initOperation({ required TrackingConfiguration widgetConfigurationJSON }) async {
  final Map res = await methodChannel.invokeMethod('initOperation', {"widgetConfigurationJSON": widgetConfigurationJSON.toJson()});
  return res;
}

Configuração básica

Para iniciar o componente atual, deverá ser criado um objeto TrackingConfiguration que será a configuração do controlador do componente.

A configuração básica necessária é a seguinte:

class TrackingConfiguration
{
  TrackingOperationType mType;
  String mCustomerId;
}

Configuração avançada do componente

A seguir, são detalhados todos os campos que fazem parte desta classe.

Configuração do Init Operation

---

closeSession

Antes que a aplicação seja destruída, a sessão do SDK deverá ser encerrada para avisar à plataforma sobre sua finalização. Para isso, executa-se o seguinte trecho de código:

@override
Future<Map> closeSession() async {
  final Map res = await methodChannel.invokeMethod('closeSession', {});
  return res;
}

---

getExtraData

O método getExtraData permite gerar os identificadores necessários para uma operação que deva continuar no Serviço de Validações da Facephi (Backend). Essa situação costuma ocorrer em casos nos quais, uma vez obtidas as informações necessárias na aplicação do cliente, seja necessário enviar essas informações a um determinado serviço para validação ou análise posterior. Caso os resultados desses processos precisem ser rastreados na Plataforma, ela deverá ser capaz de unificar a primeira parte do processo realizada no cliente com a última realizada no serviço, já que, no final, ambas fazem parte da mesma operação.

@override
Future<Map> getExtraData() async {
  final Map res = await methodChannel.invokeMethod('getExtraData', {});
  return res;
}

Lançamento de IDV

O processo de IDV inicia um fluxo configurado na plataforma a partir do seu ID (flowID). Para isso, será necessário invocar dois métodos: initFlow + startFlow.

initFlow

Neste método, será definida a configuração necessária. O ID do fluxo configurado na plataforma (flowID) e o ID do cliente (customerID). Veja o código:

await FphiSdkmobileCore().initFlow(widgetConfigurationJSON: FlowConfiguration(
    mCustomerId: customerId,
    mFlow: "f40c098c-a878-4976-aef1-2af6bbf55148"
));

Para configurar o controlador de fluxos, será criada uma lista dos controladores dos componentes que participarão no processo, o que permite inicializá-los corretamente. A ordem em que forem definidos não é importante; o próprio fluxo indicará a ordem em que serão executados. Por exemplo:

• setSelphiFlow: Captura Facial

• setSelphidFlow: Captura de documentos

Código para o lançamento:

// Se initFlow retornar STATUS_OK. Chamo os fluxos, invocando um a um os controladores
CoreWidget().initFlow().then((r) async
{
  r.map((r) async
  {
    if (r.finishStatus == SdkFinishStatus.STATUS_OK).
    {
      /* Serão chamados tantos métodos de configuração do flow's quantos fluxos forem usados */
      /* No exemplo, um flow típico de Onboarding */
      await SelphiFaceWidget().setSelphiFlow().then((value) {
        if (kDebugMode) {
          print(value);
        }
      });
      await SelphIDWidget().setSelphidFlow().then((value) {
        if (kDebugMode) {
          print(value);
        }
      });
      
      /* Ao final de adicionar os fluxos, o startFlow é iniciado (desde que os métodos anteriores não falhem) */
      await CoreWidget().startFlow().then((value)
      {
        if (kDebugMode) {
          print(value);
        }
      }).onError((error, stackTrace) {
        if (kDebugMode) {
          print(error);
        }
      });
    }
  });
}).onError((error, stackTrace) {
  if (kDebugMode) {
    print(error);
  }
});

/* Os resultados são recebidos implementando um BasicMessage, com a key 'core.flow' */
const channel = BasicMessageChannel<dynamic>('core.flow', StringCodec());
channel.setMessageHandler((message) async
{
  if (jsonDecode(message!)['flow'] == "SELPHID")
  {
    if (kDebugMode) {
      print(SelphIDResult.fromMap(jsonDecode(message)));
    }
  }
  else if (jsonDecode(message!)['flow'] == "SELPHI")
  {
    if (kDebugMode) {
      print(SelphiFaceResult.fromMap(jsonDecode(message)));
    }
  }
  else
  {
    if (kDebugMode) {
      print(jsonDecode(message));
    }
  }
  return '';
});

Recepção do resultado

O lançamento de TODOS os métodos retornará as informações no formato CoreResult. Podendo-se diferenciar entre um lançamento correto e um incorreto:

class CoreResult {
  final SdkFinishStatus finishStatus;
  final String finishStatusDescription;
  final String errorDiagnostic;
  final String? errorMessage;
  final String? data;
}

Core Resultado