> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-pt-br/sdks/sdk-web/ejemplos-de-integracion/uso-basico.md).

# Uso básico

Exemplo básico de integração do SDK Web.

O guia a seguir mostra um exemplo de integração em um ambiente TypeScript + VITE. Esse mesmo processo pode ser realizado nos frameworks atuais, com as diferenças exigidas pelo ambiente (sintaxe, definição de componentes etc.).

Este exemplo se baseia em uma integração básica. É possível alterar o comportamento do fluxo com as configurações ou mudanças necessárias.

Nesta integração, serão utilizados os componentes SDK Provider, Widget SelphID, Widget Selphi e Tracking (incluído no SDK Provider).

***

### Instalação do componente

Instale a biblioteca SDK Web:

```bash
npm install @facephi/sdk-web-wc@latest
```

{% hint style="info" %}
Não se esqueça de preparar o arquivo `.npmrc` com as credenciais para o download.
{% endhint %}

Defina os custom elements:

```javascript
// main.ts
import '@facephi/sdk-web-wc';
import { defineCustomElements as defineFacephiSDKCustomElements } from '@facephi/sdk-web-wc/loader';

defineFacephiSDKCustomElements(window);
```

***

### Integração e configuração do SDK Provider

Integre e configure o SDK Provider:

{% code title="App.tsx" %}

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

<section className="facephi-sdk-provider">
  <facephi-sdk-provider
    apikey={import.meta.env.VITE_LICENSE_KEY}
    steps={`${TrackingSteps.start},${TrackingSteps.selphidWidget},${TrackingSteps.selphiWidget},${TrackingSteps.finish}`}
    type={TypeFamily.onboarding}
    customerId={customerId}
    language={Language.en}
  />
</section>
```

{% endcode %}

Lógica do SDK Provider:

{% code title="facephi-sdk-provider.ts" %}

```typescript
import { initSelphidWidget } from './facephi-selphid-widget';
import { ErrorData } from '@facephi/sdk-web-wc';

(async () => {
	await customElements.whenDefined('facephi-sdk-provider');

	// SDK Provider event handlers
	function handleEmitData(event: CustomEvent<{ operationId: string; sessionId: string; extraData: string }>) {
		const result = event.detail;
		console.log('[FACEPHI SDK PROVIDER] onEmitData', result);
	}

	function handleEmitError(event: CustomEvent<ErrorData>) {
		const result = event.detail;
		console.error('[FACEPHI SDK PROVIDER] onEmitError', result);
	}

	const sdkProvider = document.querySelector('facephi-sdk-provider');
	if (sdkProvider) {
		sdkProvider.addEventListener('emitData', handleEmitData);
		sdkProvider.addEventListener('emitError', handleEmitError);
		
		// Initializes the SelphID widget
		initSelphidWidget(sdkProvider);
	}
})();
```

{% endcode %}

Lógica do Widget SelphID:

{% code title="facephi-selphid-widget.ts" %}

```typescript
import {
	Language,
	type ExtractionFinishEvent,
} from '@facephi/selphid-web-component';
import { initSelphiWidget } from './facephi-selphi-widget';

export function initSelphidWidget(sdkProvider: HTMLElement) {
	sdkProvider.innerHTML = '';
	const selphidWidget = document.createElement('facephi-selphid-widget');
	selphidWidget.country = 'GB';
	sdkProvider.appendChild(selphidWidget);

	// SELPHID EVENTS
	function handleExtractionFinish(event: CustomEvent<ExtractionFinishEvent>) {
		const result = event.detail.detail;
		Logger.printLog(LoggerType.SELPHID, 'extractionFinish', result);

		// Initialize Selphi
		initSelphiWidget(sdkProvider);
	}
	
	// otros eventos

	if (selphidWidget) {
		selphidWidget.addEventListener('extractionFinish', handleExtractionFinish);
	}
}
```

{% endcode %}

Lógica do Widget Selphi

{% code title="facephi-selphi-widget.ts" %}

```typescript
import {
	Language,
	type ExtractionFinishEvent,
} from '@facephi/selphi-web-component';

export function initSelphiWidget(sdkProvider: HTMLElement) {
	sdkProvider.innerHTML = '';
	const selphiWidget = document.createElement('facephi-selphi-widget');
	selphiWidget.stabilization = true;
	selphiWidget.interactible = true;
	selphiWidget.previewImage = true;
	selphiWidget.timeout = 30000;
	selphiWidget.showLog = false;
	sdkProvider.appendChild(selphiWidget);

	//SELPHI EVENTS
	function handleExtractionFinish(event: CustomEvent<ExtractionFinishEvent>) {
		const result = event.detail.detail;
		console.log('[FACEPHI SELPHI] extractionFinish', result);

		// Finish onboarding process with any logic
		sdkProvider.innerHTML = '<div class="onboarding-finished">ONBOARDING FINISHED</div>';
	}
	
	// Otros eventos

	if (selphiWidget) {
		selphiWidget.addEventListener('extractionFinish', handleExtractionFinish);
	}
}
```

{% endcode %}

{% hint style="info" %}
Esta é apenas uma aproximação. É possível utilizar diferentes tipos de integração ou sintaxe.

Neste exemplo, foi considerado apenas o *caminho feliz*, portanto, os demais eventos também precisam ser integrados em implementações reais.
{% endhint %}

***

### Integração e configuração do fluxo de componentes

Este exemplo é uma integração do *Happy Path* para um Onboarding realizado por meio do SelphID e do Selphi.

Primeiro, com a instanciação do SDK Provider, será executada a lógica interna para inicializar todos os serviços (Carregamento, Licenciamento, Inicialização do Tracking etc.).

Quando o Provider emitir o evento `emitData`, o primeiro Widget (SelphID) será carregado por meio da lógica de `initSelphidWidget(sdkProvider)`.

Depois que o usuário concluir o processo de captura, o Widget SelphID será fechado e emitirá o evento `extractionFinish`. Nesse evento, os dados serão processados conforme necessário e o próximo componente (Selphi) será carregado com o método `initSelphiWidget(sdkProvider);`.

Por fim, quando o usuário terminar de realizar a extração do padrão facial, os dados obtidos serão processados conforme necessário, e o fluxo será encerrado, dando continuidade à lógica desejada.

#### Fluxo entre componentes

Em ambientes mais completos, como os frameworks atuais, é possível utilizar componentes, roteadores, stores e todo tipo de ferramenta para realizar esse fluxo.

A equipe da Facephi recomenda utilizar componentes e roteadores para uma integração mais modular, simples e rápida no framework desejado.

***

### Testes de comportamento

Depois de concluir a integração, é altamente recomendável testar no ambiente de desenvolvimento do aplicativo se o funcionamento está conforme o esperado, levando em conta as possíveis configurações e situações que possam surgir no fluxo dos usuários finais.

***
