Referência do SDK
Todo SDK do Keyda — Android, iOS, React Native, Flutter, Ionic — implementa o mesmo pequeno contrato. Se você usou um, usou todos.
A API
| Ligar | O que ele faz |
|---|---|
init / initialize | Armazena o seu client id. Valida-o e falha de forma clara caso esteja malformado. |
show | Apresenta o chat sobre o seu aplicativo. |
dismiss | Fecha o caso. |
isShowing | Se está apresentado no momento. |
Deliberadamente, 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, para ambiente de homologação ou instalação auto-hospedada.
Por que uma web view e quanto ela custa para você
Há uma única interface de chat, fornecida pela plataforma, e todas as superfícies a carregam.
O que você recebe: 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 imediatamente, 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 lançar do que descubra depois.
Garantias que cada SDK oferece
- Fugas 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 de rodapé encerra a conversa do cliente sem volta.
- Continuidade da conversa. O armazenamento DOM está ativado, então um cliente que fecha o aplicativo e retorna encontra o histórico onde o deixou (por 24 horas).
- O teclado nunca cobre o campo de entrada.
- As áreas seguras são respeitadas — nenhum chat é exibido sob o entalhe da tela ou o indicador de início.
- Nenhum erro afeta a sua aplicação. Um carregamento falhado mostra uma tentativa de repetição.
- Sem análises, sem identificadores de dispositivos, sem dependências de terceiros. Adicionar um SDK da Keyda não adiciona nenhum localizador à sua aplicação.
Formato do Client id
kb_live_ followed by 8-48 hexadecimal charactersQualquer 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 a sua conta. Consulte limites e segurança.
Origem
Público, com licença MIT: github.com/KeydaAI/keyda-business-sdks. O contrato compartilhado que todos os pacotes devem seguir está em CONTRACT.md no topo desse repositório.