Developers

Aparência

Vai integrar o SDK web da Zarv com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar o SDK web da Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/sdk/
- Contrato do SDK e instalação do loader: https://developers.zarv.com/sdk/
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

O SDK é imperativo: carregue https://js.zarv.com/sdk.js e chame Zarv('<produto>', config) — um verbo e um objeto de config, igual para todos os produtos. Não há ambiente de desenvolvimento: o host é sempre js.zarv.com, e testes se separam por chave pública.

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [ex.: escolher e embutir o produto certo do SDK no meu site]

SDK Zarv ​

O SDK Zarv é um único loader que serve dois produtos sob o mesmo window.Zarv:

  • Chat — o widget de conversa que aparece como um launcher no canto da página.
  • Smartflow — o funnel de cadastro/KYC embutido na sua aplicação.

Você carrega um único script e escolhe qual produto usar pela forma como o configura.

Instalação ​

Adicione o loader à sua página:

html
<script async src="https://js.zarv.com/sdk.js"></script>

Não há ambiente de desenvolvimento separado para o SDK. js.zarv.com é o único host que você usa — em produção, em homologação e na sua máquina. O host js.zarv.dev existe, mas é o staging interno da Zarv: não integre contra ele.

Para testar sem afetar dados reais, use uma campanha/bot de teste (criada no admin) em vez de um ambiente separado — a chave pública é o que separa um do outro.

O SDK roda em qualquer origem — não há restrição de CORS para o JavaScript do loader, então localhost funciona sem configuração.

Versionamento ​

O loader lê /sdk/version.json e carrega os bundles versionados com verificação de integridade (SRI). Novas versões são publicadas automaticamente, então integrar via sdk.js sempre traz a versão mais recente sem mudanças do seu lado — é o que recomendamos.

O manifesto descreve cada produto separadamente: versão, arquivos e os hashes SRI correspondentes.

json
{
  "loader": "0.38.0",
  "chat": {
    "version": "0.80.5",
    "file": { "js": "widget.0ae8404e.js", "css": "widget.7a2f16d4.css" },
    "integrity": { "js": "sha384-…", "css": "sha384-…" }
  },
  "smartflow": {
    "version": "0.40.0",
    "file": { "js": "smartflow.c85d54b9.js", "css": "smartflow.a3ffc7e0.css" },
    "integrity": { "js": "sha384-…", "css": "sha384-…" }
  }
}

O caminho de um bundle é /sdk/<produto>/v<versão>/<arquivo>, e o <arquivo> é derivado do conteúdo — muda a cada build. Ou seja, você não consegue montá-lo à mão: tanto o nome quanto o integrity precisam sair do version.json. É por isso que esses caminhos podem ser servidos com cache imutável.

Se você precisa fixar uma versão (reprodutibilidade, auditoria), leia o manifesto uma vez, guarde o par arquivo + integrity daquele build e sirva o <script> você mesmo:

html
<script
  async
  src="https://js.zarv.com/sdk/chat/v0.80.5/widget.0ae8404e.js"
  integrity="sha384-…"
  crossorigin="anonymous"
></script>

Fixar significa exatamente isso: você deixa de receber correções automaticamente e passa a ser responsável por atualizar o par. Prefira o sdk.js.

Próximos passos ​

  • Chat — configuração declarativa do widget de conversa.
  • Smartflow — configuração imperativa do funnel de cadastro/KYC.