⚙️Configuração geral

1.0 🎥 Vídeo explicativo - Chave de aplicação

Instale a Koin na sua loja VTEX de forma rápida e automática seguindo as etapas demonstradas no vídeo abaixo:

📌

O vídeo aborda todas as etapas necessárias (descritas abaixo) para gerar a chave de aplicação.

1.1 🛡️ Criar função para atribuir permissões ao usuário

Para configurar as permissões de acesso corretamente, siga os passos abaixo:

1️⃣ Acesse o menu:

CONFIGURAÇÕES DE CONTA → Configurações de conta → Perfis de acesso

(Localizado no menu lateral esquerdo)

2️⃣ Crie um novo perfil de acesso somente leitura para os serviços do OMS.

Clique no botão "Novo perfil":

3️⃣ Preencha os dados da nova função de acesso

Insira o seguinte nome:

Certifique-se de que o tipo esteja como Custom:

4️⃣ Atribua as permissões específicas

Produto: OMS

Selecione o produto OMS e marque as permissões abaixo:

• ✅ View order
• ✅ List Orders
• ✅ Feed v3 and Hook Admin

Produto: PCI Gateway

Clique em Configurar outro produto, selecione PCI Gateway e marque:

• ✅ View Payment Data

✅

Essas configurações garantem que o usuário tenha acesso apenas de leitura às informações de pedidos e dados de pagamento, mantendo a segurança e integridade das operações.

1.2 🔐 Criação de credenciais e chave de aplicação (enviar para a Koin)

Para que a Koin consiga acessar os serviços da sua loja com segurança, é necessário criar uma chave de aplicação. Siga o passo a passo abaixo:

1️⃣ Acesse o menu de geração de chaves

Você pode acessar diretamente via URL: {store}.myvtex.com/admin/mykeys/new/

Ou navegar por:

CONFIGURAÇÕES DE CONTA → Chaves de aplicação → Gerenciar minhas chaves
Depois, clique em “Gerar chave”:

2️⃣ Preencha as informações da chave

• Nome da chave (ex: koin-app)
• Perfil de acesso: OMS Readonly (criado na etapa anterior)
• Clique em "Gerar"

3️⃣ Copie e salve o segredo

Após gerar a chave, será exibido o AppKey e o AppToken (segredo).
⚠️ IMPORTANTE: copie e salve o segredo imediatamente, pois ele não poderá ser acessado novamente.

4️⃣ Verifique se a chave está ativa

Certifique-se de que a chave criada está com o status ativo.

🔒

Esta funcionalidade só está disponível para o usuário proprietário da loja.

Envie a chave (AppKey) e o segredo (AppToken) gerados para a equipe da Koin de forma segura.

1.3 📩 Envio de credenciais

Após concluir todas as etapas anteriores, envie os dados gerados para a equipe da Koin:

• 🔑 AppKey
• 🕵️ AppToken

Essas credenciais foram criadas na etapa 1.2 e devem estar vinculadas ao perfil OMS Readonly definido em 1.1.

⚠️

Envie as credenciais por um canal seguro, como e-mail criptografado ou ferramenta de comunicação oficial usada com a Koin.