⚙️ Visão Geral dos Módulos

O Public SDK organiza o acesso à API Pública em dois módulos principais:

• Api
• Tracking

Ambos compartilham a mesma estrutura de organização, porém com comportamentos diferentes.

🌐 Api

O módulo Api é responsável por:

• Consumir a API Pública da Uappi
• Retornar dados tipados (TypeScript)
• Gerenciar automaticamente a persistência de dados

Ideal para quando você precisa apenas consumir dados.

📊 Tracking

O módulo Tracking funciona como uma camada acima do Api.

Além de consumir os dados, ele também:

• Dispara eventos automaticamente para o GA4
• Dispara eventos para o Facebook Pixel, quando o fbq está carregado na página
• Padroniza o envio de eventos de comportamento
• Facilita integrações com ferramentas de marketing

Ideal para páginas e interações importantes da jornada do usuário.

⭐ Utilitário de avaliação

A partir da versão 2.2.0, o SDK exporta formatReviewAverage. Use essa função para exibir a média de avaliação do produto (review.averageRating).

A média é decimal, com 2 casas. A função sempre mostra 2 casas no formato pt-BR. Um valor vazio ou inválido mostra 0,00.

1import { formatReviewAverage } from '@uappi/public-sdk/modules/Review';
2
3formatReviewAverage(4.666);     // "4,67"
4formatReviewAverage(4);         // "4,00"
5formatReviewAverage(undefined); // "0,00"

O módulo Review não depende de Vue.

🧱 Estrutura dos módulos

Os dois módulos são organizados por domínio:

💡 Exemplo comparativo

1// Sem tracking
2Api.customization.listBanners('home');
3
4// Com tracking
5Tracking.customization.listBanners('home');

🏁 Próximo passo

SDK Público - Api: Introdução