SPREEAI/Desenvolvedores/Documentação

Construa com
SPREEAI.

Um caminho prático desde a escolha da integração até o lançamento testado. Comece com uma jornada de compra, use o acesso de teste concedido e mantenha as credenciais fora do código do navegador.

Guia públicoSDK Web v3.0.0Atualizado em outubro de 2026

Escolha o caminho de integração

CaminhoIdeal paraPrimeira ação
Aplicativo ShopifyConfiguração rápida de loja virtual gerenciadaInstale o aplicativo
SDK WebWeb personalizada ou sem interface gráficaLeia o guia do SDK
iOS / AndroidAplicativos de compras nativosEscolha um guia nativo
APIs públicasFluxos de trabalho aprovados no servidorReferência aprovada aberta
Rede de Parceiros da AmazonIntegração com o MarketplaceEm breve
Segurança de credenciais. Os exemplos usam apenas marcadores. SPREEAI emite acesso aprovado durante o processo de integração. Nunca publique segredos de cliente, chaves de API, tokens, nomes de host privados ou dados de clientes.

Aplicativo Shopify

Use o aplicativo gerenciado quando a loja estiver em execução no Shopify e não precisar de um backend personalizado. O fluxo de integração atual conecta a loja após os contratos e a assinatura; não é necessário copiar chaves de API na tela de configuração.

  1. Instale o aplicativo oficial SPREEAI e conclua o fluxo de consentimento gerenciado.
  2. Sincronize um grupo de catálogo inicial e verifique os estados de prontidão do produto.
  3. Personalize o posicionamento e o estilo em um tema duplicado.
  4. Validar produtos elegíveis, variantes, comportamento em dispositivos móveis e adições ao carrinho.
  5. Publicar somente após aprovação da marca e do controle de qualidade.

Abra o guia oficial de integração do Shopify

Guia rápido do SDK Web

Usar @spreeai/web-sdk para personalização de posicionamento, estilo, eventos, tamanho e comportamento do carrinho.

npm install @spreeai/web-sdk@3.0.0

import { init } from "@spreeai/web-sdk";
import "@spreeai/web-sdk/dist/web-sdk.css";

// Add <div id="spreeai-try-on"></div> to the product page first.
const sdk = await init({ clientId: "your-client-id" });

if (sdk) {
  await sdk.renderTryOnButton({
    elementId: "spreeai-try-on",
    garments: [{ garmentId: "your-garment-id" }],
    enableAddToCart: true,
  });
}

Inicialize uma única vez, renderize apenas para um produto elegível e conecte os callbacks de cliente documentados às suas análises existentes. Confirme a interface atual em Referência oficial da API do SDK da Web

Acesso à API

Utilize a referência pública do Swagger apenas para fluxos de trabalho do lado do servidor aprovados durante o processo de integração. Mantenha os dados confidenciais no seu servidor, separe o acesso de teste do acesso de produção e limite as credenciais ao ambiente mínimo necessário.

Endpoints REST diretos, webhooks ou comportamentos de autenticação não presentes na referência pública aprovada devem ser considerados indisponíveis até que a equipe de Engenharia de Parceiros os confirme.

Abra a referência da API pública aprovada.

Linha de base de ativos de vestuário

  • JPEG ou PNG; mínimo de 2.000 × 2.000 px, sendo aproximadamente 4K o ideal.
  • Uma peça de roupa por imagem, centralizada com bordas nítidas e iluminação neutra e uniforme.
  • A vista frontal é obrigatória; a vista traseira é recomendada quando essa opção estiver ativada.
  • SKU estável, modelo ou ID da peça incluídos no nome do arquivo e no registro do catálogo.
  • Sem mãos, cabides, acessórios de styling, marcas d'água ou peças de roupa irrelevantes bloqueando a visão do item.
  • O mapeamento de variantes foi verificado antes de ativar a experiência.

Controle de qualidade e lançamento

  • Teste toda a jornada do cliente nos navegadores atuais para dispositivos móveis e computadores.
  • Verificar o mapeamento de produtos e variantes, a disponibilidade da peça e o comportamento do carrinho de compras.
  • Verifique o acesso por teclado, a ordem de foco, os nomes acessíveis e o comportamento de fallback.
  • Meça o desempenho da página do produto antes e depois de ativar SPREEAI.
  • Estados de carregamento, vazio, indisponível, tempo limite excedido e tentativa de repetição.
  • Confirme o idioma de consentimento e o tratamento aprovado das imagens do cliente.
  • Obtenha a aprovação das áreas de engenharia, comercial, controle de qualidade e da marca antes da produção.

Solução de problemas

O botão não aparece.

Confirme a inicialização do SDK, o identificador do cliente, o ID do elemento host, a elegibilidade do produto, a prontidão da peça e o mapeamento de variantes. Em seguida, verifique o console do navegador e os erros de rede sem compartilhar tokens.

O produto ou variante exibido está incorreto.

Compare os IDs do produto e da variante na loja virtual com os registros enviados para SPREEAI. Confirme se a solicitação exibida muda quando o cliente altera as variantes.

A experiência é lenta ou indisponível.

Teste um produto comprovadamente pronto para uso, verifique o ambiente ativo, inspecione as solicitações bloqueadas e compare com uma sessão limpa do navegador. Registre um carimbo de data/hora e uma sequência reproduzível para suporte.

Obtenha suporte do desenvolvedor

E-mail support@spreeai.com Inclua informações como o ambiente, o ID do produto ou da peça de roupa, o navegador ou dispositivo, o horário aproximado, o comportamento esperado e as etapas para reprodução. Não inclua segredos ou imagens do cliente.

Documentação

Escolha seu idioma.