Através de chaves de acesso (access tokens), a funcionalidade de Aplicativos sob medida permite conectar ferramentas próprias aos dados do seu negócio via API, sem precisar recorrer a soluções intermediárias ou de se tornar um parceiro.
Neste tutorial, detalhamos como você pode gerenciar esses tokens e permissões no dia a dia, atualizar escopos de permissão, desativar ou renovar chaves antigas e, se necessário, exportar relatórios completos de auditoria para o seu e-mail.
Helpjuice Warning Callout Title
Essa funcionalidade está disponível para os planos Escala e Next.
Como gerenciar os tokens e permissões?
Dar permissão de acesso a um desenvolvedor
Você pode permitir que um desenvolvedor da sua equipe ou externo crie, desative, renove e gerencie os tokens sem dar a ele acesso completo ao painel administrativo da sua loja. Basta seguir os passos abaixo:
1. Acessar o painel administrador Nuvemshop.
2. Seguir pelo caminho “Configurações > Usuários e notificações”.
3. Clicar em “Editar” no usuário que deseja ou adicionar um novo usuário.
4. Descer até a seção Permissões e selecionar a opção “Aplicativos sob medida”.
5. Clicar em "Salvar".
Pronto!
Atualizar permissões (Escopos)
Você pode alterar as permissões de um app sob medida a qualquer momento. Para alterar o acesso de um token existente, basta seguir os passos abaixo:
1. Acessar o painel administrador Nuvemshop.
2. No menu lateral, na seção Aplicativos, clicar em “Aplicativos sob medida”.
3. Clicar no nome do aplicativo que deseja atualizar a permissão.
4. Na seção Perfis de acesso, marcar ou desmarcar as permissões desejadas.
5. Clicar em "Salvar".
Pronto!
As novas permissões passam a valer imediatamente, sem que o token perca a validade.
Excluir, Desativar ou Renovar tokens
Se você suspeita que um token foi exposto ou deseja trocá-lo por segurança, você pode excluir, desativar ou renovar token direto pelo painel. Basta seguir os passos abaixo:
1. Acessar o painel administrador Nuvemshop.
2. No menu lateral, na seção Aplicativos, clicar em “Aplicativos sob medida”.
3. Clicar no nome do aplicativo que deseja atualizar a permissão.
4. No canto superior direito, você terá as opções de Excluir, Desativar ou Renovar token:
Excluir
Ao clicar em “Excluir”, o token e suas configurações serão permanentemente excluídos e você precisará criar um novo do zero.
Desativar
Ao clicar em “Desativar” o token seguirá existindo, porém deixará de funcionar até que você reative. O status dele ficará como Desativado.
Para ativar o token novamente, basta clicar no ícone da coluna Ações e selecionar “Ativar”:
Renovar token
Ao clicar em “Renovar token”, você vai criar um novo token com as mesmas regras e permissões do anterior. É possível escolher duas formas de como fazer a renovação:
- De forma imediata: o token antigo deixa de funcionar na hora.
- Com período de transição: o token antigo continua válido por até 2 dias, permitindo migrar suas integrações sem ficar fora do ar.
Se o token que você quer renovar já está em uso por integrações ativas, a renovação imediata pode interromper o serviço, pois o token antigo deixa de funcionar na hora e os sistemas que ainda dependem dele passam a receber erros. Nesses casos, recomendamos usar a renovação com período de transição, assim você terá tempo suficiente para migrar as integrações para o novo token de forma gradual.
Para definir a data em que o token antigo deve parar de funcionar, basta mover a “bolinha” na horizontal. Você pode escolher desde 0 horas (para uma renovação imediata) até 48 horas (2 dias). Feito isso, basta clicar em “Gerar novo token”.
Helpjuice Warning Callout Title
Se você definiu um período de transição, na data escolhida o token antigo deixará de funcionar automaticamente. A partir desse momento, apenas o novo token ficará válido. Durante o período de transição os dois tokens irão funcionar, sem riscos de interrupção.
Ao confirmar, clicar em “Revelar” e copiar o novo token imediatamente. Lembre-se que ele só irá aparecer completo uma única vez na tela. Na sequência, você já pode atualizar suas integrações para usarem o novo token.
Como acompanhar uma transição em andamento?
Enquanto a transição estiver ativa, a página do token mostra um aviso visual indicando: a data em que o token antigo será desativado, os 4 últimos dígitos do token antigo (ex.: ••••••aB3c) e os 4 últimos dígitos do token novo.
Helpjuice Info Callout Title
Use essa informação para confirmar qual chave está em qual integração.
Como cancelar uma transição?
Se você mudar de ideia e quiser cancelar a transição para o novo token, basta clicar em “Cancelar renovação > Confirmar cancelamento” no aviso da página do token.
Ao cancelar:
- O token antigo volta a ser permanente (sem data de expiração).
- O novo token é revogado imediatamente e deixa de funcionar.
Helpjuice Success Callout Title
Ao iniciar uma renovação com período de transição, qualquer link compartilhável que você tenha gerado para o token antigo deixa de funcionar. Se você precisar compartilhar o novo token com um desenvolvedor externo, gere um novo link de compartilhamento a partir do novo token.
Helpjuice Warning Callout Title
Não há limites de tokens, você pode criar quantos quiser.
Histórico de ações
Na página de detalhes de cada token, existe o "Histórico de ações". Essa seção funciona como uma auditoria de segurança e mostra todos os eventos da chave, como:
- Quando o app foi criado e por quem;
- Mudanças de escopos;
- Instalações e desinstalações;
- Geração e revelação do token;
- Início, conclusão ou cancelamento de uma renovação com período de transição.
Use esse histórico para auditoria de segurança e rastreamento de quem fez o quê.
Exportar
No cabeçalho, ao clicar na opção “Exportar”, você poderá baixar as informações de todos os seus aplicativos sob medida e as suas chaves de acesso. Para isso, basta seguir os passos abaixo:
1. Acessar o painel administrador Nuvemshop.
2. No menu lateral, na seção Aplicativos, clicar em “Aplicativos sob medida”.
3. No canto direito do cabeçalho, clicar em “Exportar”.
4. Você receberá um e-mail com o link de download na sequência. Acessar o sua caixa de entrada e localizar o e-mail. Feito isso, clicar em “Baixar arquivo.csv”.
Pronto!
Agora você já sabe como gerenciar e proteger os seus Aplicativos sob medida de forma totalmente autônoma pelo painel administrador Nuvemshop.
Como boa prática de segurança, lembre-se de revisar periodicamente os perfis de acesso ativos e acompanhar o histórico de ações para garantir que as chaves da sua loja estejam sempre protegidas. Caso precise conectar uma nova ferramenta externa, o ideal é gerar sempre um token exclusivo para ela.
Perguntas Frequentes
Posso usar os dois tokens ao mesmo tempo durante o período de transição?
Sim, você pode usar os dois tokens ao mesmo tempo durante o período de transição. Esse é exatamente o objetivo dessa opção. Durante a transição (até 2 dias por padrão), o token antigo e o novo funcionam normalmente. Recomendamos usar esse intervalo para migrar suas integrações sem pressa e sem ficar fora do ar.
Posso renovar o token de novo enquanto uma transição ainda está em andamento?
Sim, é possível renovar o token de novo enquanto uma transição ainda está em andamento. Se você iniciar uma nova renovação durante uma transição ativa, a transição anterior é substituída pela nova, ou seja, o token mais recente passa a ser o “atual” e o anterior entra em um novo período de transição.
O que acontece com o link de compartilhamento do token quando eu renovo?
Os links de compartilhamento gerados para o token antigo deixam de funcionar assim que você inicia a renovação (com ou sem transição). Se você precisar compartilhar o novo token com um desenvolvedor externo, gere um novo link a partir da página do novo token.
É enviado uma notificação por e-mail quando o token antigo for desativado?
Não. Atualmente não é enviado notificação por e-mail quando um token é desativado. A data de desativação é definida por você no momento da renovação e fica visível no aviso da página do token enquanto a transição estiver ativa. Recomendamos planejar a migração das integrações com base nessa data.
Posso cancelar uma transição depois de iniciar?
Sim, enquanto a data de desativação ainda não chegou. Ao cancelar, o token antigo volta a ser permanente e o token novo é revogado imediatamente. Depois que o período de transição expira, a transição é concluída e não pode mais ser cancelada.