Keyda Business
BrazilEnglish Entrar Começar grátis
Documentação do Keyda BusinessReferência

Referência de SDK

Todo SDK do Keyda — Android, iOS, React Native, Flutter, Ionic — implementa o mesmo contrato pequeno. Se você usou um, usou todos.

A API

LigarO que ele faz
init / initializeArmazena o seu client id. Valida-o e falha de forma clara se estiver mal formatado.
showExibe o chat sobre o seu aplicativo.
dismissEncerra o atendimento.
isShowingSe está sendo apresentado agora.

Propositalmente, não há mais nada. Nenhuma API de envio de mensagens, nenhuma contagem de não lidas, nenhuma chamada de identidade de usuário — porque nada disso funciona de ponta a ponta ainda, e um método que não funciona é pior do que um que está faltando.

A URL que cada SDK abre

{baseUrl}/chat/{clientId}

baseUrl tem como padrão https://keyda.in/business e pode ser substituído em qualquer plataforma, seja para ambiente de testes (staging) ou instalação auto-hospedada.

Por que uma web view e quanto ela custa a você

Há uma única interface de chat, fornecida pela plataforma, e todas as superfícies a carregam.

O que você ganha: uma alteração feita pelo proprietário no painel — cor de destaque, mensagem de boas-vindas, nome do bot, ativação — chega a todos os aplicativos instantaneamente, sem necessidade de nova versão. Uma correção é aplicada em todos os lugares de uma só vez. O chat é idêntico em todas as plataformas.

Quanto custa: o chat precisa de uma conexão. Não há modo offline e ainda não há notificações push.

Preferimos que você saiba disso antes de publicar do que descubra depois.

Garantias que cada SDK oferece

  1. Saídas de navegação. Um link para qualquer outra origem abre no navegador do sistema em vez de substituir o chat. Sem isso, um toque em um link derodapé encerra a conversa do cliente sem caminho de volta.
  2. Continuidade da conversa. O armazenamento local (DOM storage) está ativado, então um cliente que fecha o app e volta encontra o histórico exatamente onde parou (por 24 horas).
  3. O teclado nunca cobre o campo de entrada.
  4. Áreas seguras são respeitadas — nenhum chat é desenhado sob um entalhe ou indicador de início.
  5. Nenhuma falha chega ao seu aplicativo. Um carregamento com erro exibe a opção de tentar novamente.
  6. Sem análises de dados, sem identificadores de dispositivo, sem dependências de terceiros. Adicionar um SDK da Keyda não adiciona nenhum rastreador ao seu aplicativo.

Formato do Client id

kb_live_ followed by 8-48 hexadecimal characters

Qualquer outra coisa é rejeitada na inicialização, em vez de abrir um erro 404 na frente de um cliente. O client id é público por design — fica visível em qualquer site que incorpore o widget — e não tem capacidade de ler ou alterar sua conta. Veja limites e segurança.

Origem

Público, com licença MIT: github.com/KeydaAI/keyda-business-sdks. O contrato compartilhado que todos os pacotes seguem está em CONTRACT.md no topo desse repositório.

Next: Limits and security →