Passar para o conteúdo principal

Como gerar e proteger sua chave (Token) de API

Entenda como gerar um token para consultar a API

Equipe Vnda avatar
Escrito por Equipe Vnda
Atualizado há mais de uma semana

O token de API é uma chave de acesso que permite consultar informações e desenvolver integrações com sua loja. Pense nele como a senha e o token de acesso à conta bancária do seu negócio. O tratamento inadequado pode expor sua operação a riscos.

Neste artigo, ensinaremos como gerar sua chave de forma segura.

  • SUAS CHAVES DE API SÃO AS CHAVES DO SEU NEGÓCIO

Sua loja virtual é a fonte de renda da sua empresa. Assim como você protege suas informações bancárias, suas chaves de API devem ser tratadas com o máximo rigor. Uma chave exposta pode permitir que um invasor visualize, altere ou até apague dados vitais como produtos, clientes e pedidos, comprometendo diretamente seu faturamento.

A regra de ouro é: conceda apenas as permissões (escopos) estritamente necessárias.

🚩 Para trabalhar com a API, é importante entender como ela funciona. Neste artigo, você acessa as documentações de API da Vnda e tudo que pode ser feito a partir dela.

Como gerar um token de API

1. Vá em Admin > Configurações ⚙️ > Integrações > API;

2. Clique no ícone de + para gerar um novo token:

3. Preencha com o nome da integração (ex: "Integração ERP XPTO") e o e-mail de quem deve receber o token;

4. Deixe o campo hosts em branco e defina cuidadosamente os escopos aos quais essa chave terá acesso.

⚠️ ATENÇÃO AO DEFINIR OS ESCOPOS!

Os escopos são as permissões que a chave terá. Cada escopo liberado é como autorizar uma nova operação na sua conta. Nunca selecione todos os escopos por conveniência.

Conceda apenas as permissões estritamente necessárias para a integração funcionar. Por exemplo, se uma ferramenta precisa apenas ler pedidos, conceda somente o escopo order-read. Conceder permissão para escrever (write) ou apagar dados sem necessidade cria uma grave falha de segurança.

5. Feito isso, clique em SALVAR. O token será gerado e enviado ao e-mail selecionado. O assunto do e-mail sempre será Token de acesso para API da Vnda.

Ficou com alguma dúvida? Envie a mesma para ajuda@vnda.com.br que iremos lhe auxiliar.


Não esqueça de deixar seu feedback para sabermos se deu tudo certo :)

Basta clicar nas carinhas abaixo.

Respondeu à sua pergunta?