Visão geral
As Chaves de API permitem conectar o Dashboardly a um assistente de IA como ChatGPT, Claude ou Cursor, para que o assistente responda a perguntas sobre os dados da sua TikTok Shop em linguagem simples. Você pergunta "Qual foi meu Net Profit na semana passada?" ou "Qual SKU mais vendeu ontem na minha loja do Reino Unido?" e o assistente busca a resposta diretamente nos seus dados ao vivo do Dashboardly.
A conexão usa um padrão aberto chamado Model Context Protocol (MCP), que qualquer assistente de IA moderno consegue interpretar. Você gera uma chave de API por assistente (ou uma por loja), cola-a nas configurações do assistente, e a conversa fica conectada aos seus dados.
As Chaves de API são somente leitura. Um assistente de IA pode ler todas as métricas que você vê no Dashboardly, mas não pode criar pedidos, alterar custos de produtos, editar configurações, enviar reembolsos ou modificar nada na sua TikTok Shop ou na sua conta do Dashboardly.
Você gerencia todas as chaves na página Settings > API Keys.
Requisitos de plano
As Chaves de API fazem parte do recurso de Integrações de IA do Dashboardly, disponível nos seguintes planos:
| Plano | Chaves de API incluídas |
|---|---|
| Brand Starter | Não disponível |
| Brand Growth | Disponível |
| Brand Pro | Disponível |
| Brand Elite | Disponível |
Se você estiver no Brand Starter, a aba API Keys em Settings mostra um aviso de upgrade. Faça o upgrade da sua assinatura na página Settings > Subscriptions para habilitar o recurso.
Não há cobrança por chave. Você pode criar quantas chaves quiser em um plano elegível, sem custo extra pelas consultas que o seu assistente de IA fizer.
Como funciona
Quando você cria uma chave de API no Dashboardly, duas coisas acontecem:
- A chave é gerada. Ela parece com
dk_live_...seguido de uma longa sequência aleatória. Você vê a chave completa apenas uma vez, no momento da criação. Depois disso, o Dashboardly armazena somente uma impressão digital dela, então nem mesmo a nossa equipe de suporte consegue recuperar a chave completa mais tarde. - A chave é vinculada à sua conta. Cada chave está atrelada ao seu login do Dashboardly e, opcionalmente, a uma única TikTok Shop. Quando um assistente de IA usa a chave para pedir dados, ele recebe de volta exatamente o que você veria se abrisse aquela loja no seu navegador.
Seu assistente de IA conecta-se a um endpoint do Dashboardly (o servidor MCP) e apresenta a chave. O endpoint verifica a chave, consulta qual loja a chave tem permissão de ler e retorna os dados solicitados. Cada requisição é registrada para que você possa ver com que frequência o seu assistente está usando a chave e quais perguntas ele faz.
Como a chave é somente leitura, o assistente não tem como alterar nada. A ação mais "destrutiva" que ele pode tomar é ler uma métrica.
Passo a passo: crie sua primeira Chave de API
Passo 1: Abra a página API Keys
Navegue até Settings > API Keys na barra lateral esquerda. Se você não vir a aba, verifique se a sua assinatura está no Brand Growth ou superior.
Passo 2: Clique em "New API key"
No canto superior direito da página, clique no botão + New API key. Um pequeno formulário se abre.
Passo 3: Preencha os detalhes
- Name -- Um rótulo para você reconhecer a chave mais tarde. Use algo descritivo como "Claude Desktop -- Loja US" ou "ChatGPT do John". Os nomes são visíveis somente para você.
- Shop -- Escolha uma única loja, ou deixe o campo em "All shops" para dar à chave acesso a todas as lojas que você conectou. A maioria dos usuários prefere uma chave por loja, para que cada conversa de IA fique automaticamente restrita aos dados corretos.
- Expires in -- Quantos dias até a chave parar de funcionar automaticamente. O padrão é 365 dias. Validades mais curtas são mais seguras; validades mais longas significam que você não precisa rotacionar a chave com tanta frequência. Você pode revogar uma chave a qualquer momento, independentemente da validade.
Passo 4: Clique em "Create key"
O Dashboardly gera a chave e a exibe em um painel de confirmação. A chave é mostrada por completo apenas esta única vez.
Passo 5: Copie a chave imediatamente
Clique no botão Copy para colocar a chave na sua área de transferência. Cole-a em um lugar seguro (o arquivo de configuração do seu assistente, um gerenciador de senhas ou uma nota protegida). Se você fechar o painel sem copiar, terá de revogar a chave e criar uma nova -- não há como recuperá-la novamente.
Passo 6: Conecte seu assistente de IA
Abra as configurações do seu assistente de IA e adicione o Dashboardly como uma conexão (o caminho exato varia por assistente; veja a próxima seção para orientação sobre cada um).
Passo 7: Confirme a conexão
Faça ao seu assistente uma pergunta simples como "Qual é meu Net Profit da semana passada?" Se tudo estiver configurado corretamente, o assistente responde com a resposta extraída dos seus dados ao vivo do Dashboardly. Se você vir um erro, consulte Por que meu assistente de IA não está funcionando?.
Conectando um assistente de IA
A configuração exata depende de qual assistente você usa. Depois que você cria a chave no Dashboardly, o painel de confirmação mostra trechos de configuração prontos para colar nas ferramentas mais populares.
Claude (Desktop e Web)
Nas configurações do Claude, procure por uma seção chamada Connectors, Integrations ou MCP servers. Adicione uma nova conexão colando a URL do endpoint do Dashboardly e a sua chave de API. Depois de salvar, o Claude mostra o Dashboardly como uma conexão disponível em qualquer conversa.
Se você usa o Claude Desktop, a conexão é adicionada a um arquivo de configuração que carrega quando o Claude inicia. O painel de confirmação no Dashboardly mostra o texto exato a colar.
ChatGPT
No ChatGPT, abra o menu Apps & Connectors e adicione o Dashboardly como um conector personalizado. Cole a URL do endpoint e a chave de API quando solicitado. O ChatGPT lembra da conexão em todas as suas conversas.
Cursor
No Cursor, abra Settings > MCP, clique em Add new MCP server e cole o endpoint e a chave do Dashboardly. O Cursor usa a conexão enquanto você programa, então você pode fazer perguntas como "Qual é meu SKU mais vendido neste mês?" sem sair do seu editor.
Outros assistentes de IA
Qualquer assistente que interprete o Model Context Protocol consegue se conectar. Forneça ao assistente a URL do endpoint MCP do Dashboardly e a chave de API (trate-a como uma senha). O assistente deve descobrir automaticamente quais dados estão disponíveis.
O que seu assistente de IA pode fazer
Uma vez conectado, seu assistente pode responder a perguntas em todas as principais áreas dos dados da sua loja. Você faz perguntas em linguagem simples (ou em qualquer idioma que seu assistente suporte), e o assistente decide quais dados buscar.
| Tópico | Exemplos de perguntas |
|---|---|
| Conta e lojas | "Quais lojas estão conectadas?" "Qual é o e-mail da minha conta?" |
| Resumo do Dashboard | "Me dê uma visão geral rápida da semana passada." "Como estão as vendas em comparação com o mês passado?" |
| Profit & loss | "Qual foi meu Net Profit em março?" "Detalhe meu P&L por semana no último trimestre." |
| Pedidos | "Quantos pedidos recebi ontem?" "Me mostre os pedidos cancelados dos últimos 7 dias." |
| Principais produtos | "Quais SKUs mais venderam no mês passado?" "Quais foram meus 10 principais produtos por receita neste trimestre?" |
| Reembolsos | "Quanto reembolsei na semana passada?" "Quais produtos têm a maior taxa de devolução?" |
| Clientes | "Quantos clientes recorrentes eu tenho?" "Qual é o lifetime value do meu cliente médio?" |
| Marketing e anúncios | "Qual foi meu ROAS no TikTok Ads na semana passada?" "Como estão performando minhas campanhas de anúncios?" |
| Lives e promoções | "Quais lives geraram mais vendas no mês passado?" "Quanto economizei com subsídios da plataforma em abril?" |
| Estoque | "Quais SKUs estão com estoque baixo?" "Qual é o valor atual do meu estoque?" |
| Análise geográfica | "De onde vêm a maioria dos meus pedidos?" "Como estão as vendas na Alemanha neste mês?" |
| Métricas por hora | "Qual hora do dia recebe mais pedidos?" "Me mostre as vendas de ontem hora a hora." |
O assistente não pode executar ações na sua TikTok Shop nem no Dashboardly. Ele só pode ler.
Gerenciando suas chaves
Visualizando chaves
A página Settings > API Keys lista cada chave que você criou com seu nome, os primeiros caracteres da chave (para você reconhecê-la), a loja à qual está vinculada, quando foi criada, quando foi usada pela última vez e quando expira.
Inspecionando o uso
Clique em qualquer chave ativa para expandir um painel de uso que mostra:
- Total de chamadas nos últimos 30 dias
- Taxa de sucesso (chamadas que retornaram dados com êxito)
- Tempo médio de resposta para você saber que a conexão está rápida
- Um gráfico de atividade diária dos últimos 7 dias
- As ferramentas de dados mais usadas para você ver o que o assistente mais consulta
Isso é útil para confirmar que uma chave está sendo usada, identificar atividade incomum ou ver no que seu assistente costuma se concentrar.
Revogando uma chave
Se uma chave for perdida, exposta ou não for mais necessária, clique no ícone Revoke ao lado dela. O Dashboardly bloqueia imediatamente qualquer requisição futura que use essa chave. Os assistentes de IA conectados com a chave revogada verão um erro na próxima pergunta.
A revogação é instantânea. Não há período de carência.
Validade da chave
Cada chave tem uma data de validade definida quando você a cria. O Dashboardly mostra um selo de aviso na página API Keys quando uma chave tem 14 dias ou menos restantes. Chaves expiradas param de funcionar automaticamente -- não é preciso revogá-las.
Para rotacionar uma chave em um cronograma recorrente, crie uma nova chave, atualize seu assistente de IA para usá-la e depois revogue a antiga.
Apps conectados
Alguns assistentes de IA (notadamente o ChatGPT) conectam-se por meio de um fluxo de login com um clique, em vez de exigir que você copie uma chave de API. Quando você concede ao Dashboardly acesso a um desses assistentes, ele aparece na seção Connected Apps na parte inferior da página API Keys.
Para cada app conectado você pode ver o nome dele, quando se conectou pela primeira vez, quando esteve ativo pela última vez e duas formas de desconectar:
- Revoke -- Bloqueia novos logins desse assistente. As sessões ativas permanecem válidas por até uma hora e depois expiram.
- Sign out now -- Desconecta o assistente imediatamente, encerrando qualquer sessão ativa. Use isso se você suspeitar que a conexão está sendo usada de forma indevida.
Segurança e privacidade
As chaves de API são sensíveis. Trate cada chave como uma senha.
- Nunca faça commit de uma chave em um repositório de código público. Se você fizer isso por acidente, revogue-a no Dashboardly e gere uma nova.
- Nunca compartilhe uma chave em uma mensagem de chat, e-mail ou captura de tela. Qualquer pessoa com a chave pode ler seus dados até você revogá-la.
- Use uma chave por assistente ou por dispositivo. Assim, se uma chave for comprometida em um dispositivo, você pode revogar apenas aquela chave sem perturbar suas outras conexões.
- Defina uma validade sensata. Uma chave que expira em 90 dias é mais segura do que uma que dura para sempre. Você sempre pode criar uma nova.
O Dashboardly nunca exibe a chave completa após a criação. O único lugar para encontrá-la é onde quer que você a tenha salvado quando a chave foi gerada.
Todas as requisições dos assistentes de IA são feitas por HTTPS. Cada requisição é registrada com um horário e a área de dados que ela consultou. Você pode auditar esse histórico por chave a partir do painel de uso descrito acima.
Somente leitura significa somente leitura: mesmo que uma chave fosse comprometida, um invasor poderia ver seus dados, mas não poderia alterar um único custo de produto, enviar um reembolso ou afetar a sua TikTok Shop de qualquer forma.
Perguntas frequentes
Meu assistente de IA vê toda a minha conta do Dashboardly ou apenas uma loja?
Depende de como você configurou a chave. Se você vinculou a chave a uma única loja, o assistente só vê aquela loja. Se você deixou "All shops" selecionado, o assistente pode ler dados de todas as lojas da sua conta. A maioria dos usuários prefere uma chave por loja, para maior clareza.
Posso criar chaves diferentes para diferentes membros da equipe?
Sim. Crie uma chave nomeada por pessoa ("Claude -- Maria", "ChatGPT -- John") e compartilhe cada chave somente com a pessoa que precisa dela. Se alguém sair da equipe, revogue a chave dessa pessoa sem afetar ninguém mais.
Usar um assistente de IA vai me custar mais?
Não. Não há cobrança por consulta do Dashboardly. O provedor do seu assistente de IA (OpenAI, Anthropic etc.) cobra de você separadamente pelo próprio assistente, com base na precificação dele.
Quão atualizados estão os dados que meu assistente vê?
Exatamente tão atualizados quanto o que você vê no Dashboardly. Se o dashboard mostra uma métrica atualizada há 2 minutos, é isso que o assistente recebe. Números baseados em settlement (taxas, impostos) podem ser estimados para pedidos muito recentes -- veja Por que meus dados estão atrasados? para a história completa.
Meu assistente de IA pode fazer alterações na minha loja?
Não. Toda chave de API é somente leitura. Não existe modo de "escrita" e não há planos para adicioná-lo. O máximo que um assistente pode fazer é resumir números que ele lê.
O que acontece com minhas chaves antigas se eu fizer downgrade do meu plano?
Se você fizer downgrade para o Brand Starter, todas as chaves de API existentes param de funcionar imediatamente. Faça o upgrade novamente para o Brand Growth ou superior para reativá-las, ou crie novas chaves após o upgrade.
Posso ver o que meu assistente de IA tem perguntado?
Sim. O painel de uso de cada chave mostra as áreas de dados mais usadas (pedidos, P&L, principais produtos etc.) e um gráfico de atividade de 7 dias. Não registramos as perguntas em linguagem natural que o usuário digitou -- somente quais ferramentas de dados o assistente acionou.