Início rápido

Requisitos prévios

Antes de começar, certifique-se de ter:

1

Token de autenticação

Você precisará de um Token de autenticação, fornecido pela equipe da Facephi, para acessar o SDK.

2

Node.js e gerenciador de pacotes

Certifique-se de ter Node.js e NPM (ou seu gerenciador de pacotes preferido) instalados no seu sistema.

• Site oficial do Node.js (recomendado v20+)

• Documentação do NPM

3

API Key

Gere sua primeira Integração a partir do painel do IDV Suite, uma vez criada a Integração e publicada, será gerada uma API Key associada. Este API Key será fornecido pela equipe de Suporte da Facephi.

Conceitos básicos

Carregador do SDK

O SDK Loader é um pacote leve que carrega dinamicamente o pacote @facephi/sdk-web-wc da CDN em tempo de execução. Cria e configura automaticamente o elemento <facephi-sdk-provider> na sua aplicação.

Uso básico:

example.ts

import { loadSdk } from '@facephi/sdk-loader';

const sdkElement = await loadSdk({
  apiKey: 'YOUR_APIKEY',
  containerId: 'sdk-container',
});

Como funciona

Quando você chama loadSdk():

1

O pacote de Web Components do SDK é carregado da CDN.

2

Os elementos personalizados são registrados no navegador.

3

É criado um elemento <facephi-sdk-provider> com a sua configuração.

4

O provider é inserido no elemento contêiner que você especificou.

Próximos passos

Agora que você conhece os conceitos básicos, já pode começar a integrar o SDK:

• Guia de integração: Instruções passo a passo de instalação e Integração

• Configuração do SDK: Opções de configuração da funcionalidade loadSdk

• Integração com Next.js: Guia para aplicações Next.js

• Exemplos de programação: Coleção de implementações de exemplo

Para uma visão completa da estrutura da documentação, consulte o índice principal.