Autenticando-se com usuário e senha na Interface REST

Breno Barreto

Breno Barreto

Última atualização

Nas integrações pela interface de REST, é necessário o fornecimento de alguns headers para a autenticação das consultas. Os obrigatórios são chamados de appKey e appToken, sendo possível utilizá-los com e-mail e senha, respectivamente.

Para a criação deste usuário, é preciso seguir os passos abaixo:

Entrar no License Manager da loja em questão, criar um usuário – caso ainda não haja um – e associar um respectivo perfil ao módulo em que o usuário irá atuar:

Neste caso, supondo que o mesmo terá acesso a todos os módulos, utilizaremos o Admin Super.

Será, de imediato, enviado um e-mail com um link para a validação:

Essa validação exigirá a criação de um nova senha para este novo usuário no VTEX ID:

Apenas para validação, após criada a nova senha, será solicitado autenticar-se no VTEX ID utilizando-se o token recebido nessa ação:

Isso irá levá-lo diretamente para o ambiente da loja, confirmando que o usuário encontra-se ativo e fechando-se a validação.

Basta agora inserir os dados de Email e Senha nos valores de cada header e seguir com as consultas que desejar:

Observações:

  • Para cada módulo, existirá um perfil que o representa. Por exemplo, para um usuário que atuará apenas com os dados de Pedidos, pode-se conceder o perfil “OMS – Administrador”, que o limitará apenas àquele âmbito de informações;
  • Recomendamos que a senha não tenha o caracter “#”, pois isso pode quebrar a leitura da string quando validada;
  • Caso queira descobrir as funções que cada API pode alcançar, acesse nossa documentação de APIs: help.vtex.com/developer-docs
  • Por uma questão de integridade de dados, busque que cada usuário tenha seu perfil quando no manuseio pela Interface de REST, pois toda e qualquer alteração será logada e registrada com o perfil autenticado em cada consulta.