Propriedades

Propriedades de configuração do SDK Provider.

O componente SDK Provider da Facephi é configurável por meio das seguintes propriedades, oferecendo comportamentos diferentes para os possíveis casos de uso que possam ser necessários.

Constantes

Algumas constantes ou enums podem ser importadas de @facephi/sdk-web-wc para facilitar as implementações.

import { Language, TypeFamily, TrackingSteps } from '@facephi/sdk-web-wc'

Exemplo de configuração

import { Language, TypeFamily, TrackingSteps } from '@facephi/sdk-web-wc';

<facephi-sdk-provider
    apikey={process.env.FACEPHI_SDK_APIKEY}
    steps={`${TrackingSteps.start},${TrackingSteps.selphidWidget},${TrackingSteps.selphiWidget},${TrackingSteps.finish}`}`
    type={TypeFamily.onboarding}
    customerId={'user-7f3a9c21'}
    language={Language.en}
/>

---

Recomendação: Configure as propriedades por meio de JavaScript, JSX ou dos bindings do seu framework (React, Vue, Angular, etc.). Evite a configuração HTML nativa com atributos (nombre-atributo="valor"), pois pode perder a tipagem e o formato esperado pelo componente.

Propriedades de configuração do SDK Provider

Com o uso das propriedades do SDK Provider, é possível configurar o comportamento e Fluxo de seus componentes.

Obrigatórias

• apikey: Licença obrigatória do SDK Web fornecida pela Facephi.

Tracking

• steps: Ordem das etapas do Fluxo registrado na plataforma.

• type: Tipo de operação registrada na plataforma (Onboarding ou autenticação).

• customerId: Identificador do usuário ou cliente da operação.

• operationId: Identificador da operação na plataforma.

• tenantId: Identificador de tenant para o Tracking na plataforma.

Configuração

• autoInitTracking: Inicia o Tracking automaticamente ao carregar o SDK.

• autoInitWorkflow: Inicia o fluxo de trabalho automaticamente ao carregar o SDK.

• landingApiKey: Chave API para o serviço Landing.

• proxy: URL do servidor proxy para as requisições do SDK.

• resourcesPath: Caminho personalizado para carregar recursos do SDK.

• qr: Habilita a captura no celular por meio de Código QR no desktop.

• qrExtraParams: Parâmetros extras na URL do Fluxo QR móvel.

• settingsStrictness: Controla se um valor de configuração inválido bloqueia o SDK ou é substituído pelo seu valor padrão.

• waitRequest: Aguarda a finalização das requisições de envio de dados antes de avançar no Fluxo.

Personalização

• desktopView: Ativa a visualização de desktop do SDK.

• language: Idioma dos textos do SDK e de seus componentes.

• theme: Tema visual do SDK (cores, logo e tipografia).

• customAnimations: Animações personalizadas centralizadas para os componentes do SDK.

• loadingAnimation: Caminho para uma animação de carregamento personalizada do provider.

Desenvolvimento

• debug: Ativa logs e opções de desenvolvedor.

• disabled: Desativa o Tracking e o serviço de Fluxo.