Antes de mais nada, o que é SFTP?
Em tradução livre é "Secure File Transfer Protocol", que consiste basicamente em um mecanismo seguro de transferência de dados direto para o nosso banco. Uma excelente alternativa para quando não for possível usar a nossa API (http://api-docs.omni.chat) para a sincronização do seu catálogo de produtos.
O acesso ao SFTP pode ser feito de diversas formas, mas para interação com a OmniChat será obrigatoriamente usando uma chave pública. Um dos métodos mais seguros existentes. Para isso é necessário criar um par de chaves, um privado e outro público, o qual somente a chave pública precisa ser enviada para a Omni. E o ponto é: como essas chaves são criadas?
Então agora vamos ver como se faz!
Configurações Iniciais
MacOS ou Linux
Crie as chaves usando CLI com o comando:
ssh-keygen -P "" -f transfer-key
Para acessar o serviço de sftp da OmniChat use o comando:
sftp -oIdentityFile=<private_key_path> -v <user-name>@sftp.omni.chat
Windows 10
Já no Windows, alguns passos de configuração adicionais são necessários, mas serão executados somente uma vez.
Primeiro, será preciso baixar os dois programas:
1. O WinSCP, o qual fará a conexão entre os dispositivos [Omni&Cliente]:
Link para download: https://winscp.net/download/WinSCP-5.17.8-Setup.exe
2. E o segundo o PuTTYgen, que permitirá salvar as chaves em um formato que seja possível ser lido pelo WinSCP.
Link para download 32bit.: https://puttygen.com/download.php?val=1
Link para download 64bit.: https://puttygen.com/download.php?val=4
Obs.: Clique aqui para saber se o seu equipamento é de 32bit ou 64bit.
Enquanto o download é feito, é preciso verificar se o seu equipamento está habilitado para gerar a chave em um formato específico, chamado OpenSSH, um formato específico de geração de chave que segue um protocolo de segurança, no caso SHH. Mas isso é só a título de curiosidade. Vamos iniciar essa verificação:
Passo 1.: Verificar se o OpenSSH está instalado
Abra o menu iniciar e clique em Configurações.
Depois clique em Aplicativos e em seguida em Aplicativos e Recursos:
Na sequência, clique em Recursos opcionais:
Caso o seu apareça neste formato abaixo, significa que já está instalado:
Caso o OpenSSH não esteja aparecendo nesta lista, significa que não está instalado. Para isso, basta instalar seguindo os passos indicados no site da Microsoft, basta clicar aqui.
Gerar a Chave
Depois da instalação dos programas acima mencionados e essa última validação do OpenSSH realizada no seu equipamento, já podemos realizar a chave conforme os passos abaixo.
1. Abra o primpt de comando como administrador. Para isso, clique o menu iniciar, e digite nas pesquisas: cmd
2. Clique em “Executar como administrador”, você precisará de senha para isso. Caso haja um bloqueio por parte da sua empresa, contate o seu suporte.
3. Agora vamos utilizar o OpenSSH para gerar o par de chaves SHH [privada e pública]. No prompt de comando, digite o indicado abaixo e pressione “enter”:
ssh-keygen
4. Por padrão, a chave será gerada e aparecerá o endereço onde a chave será salva, geralmente segue o padrão a seguir: C:\users\seu_nome_de_usuário\.ssh\id_rsa.
Basta pressionar “enter” novamente.
5. Será solicitado um “passfhrase”, basta apertar “enter” novamente, sem realizar nenhum preenchimento neste espaço. Na sequência será solicitado que digite a mesma “passfhrase” anterior como confirmação, basta pressionar “enter” novamente. Após isso, você deverá ver a tela abaixo:
Acesse a sua pasta C:\users\seu_nome_de_usuário\.ssh e identifique dois arquivos com o nome de “id_rsa”. Um é a chave privada [ícone em branco] e a outra é a pública [ícone com “P” conforme abaixo].
A chave pública é a chave que você deve encaminhar para o seu suporte da OmniChat. Assim será inserida essa chave dentro das nossas configurações para que então a sua conexão seja liberada.
Então encaminhe neste instante a chave pública para a Omni e peça o nome do usuário que foi criado internamente para sua empresa, e aí sim você conseguirá ativar a sua conexão. Aguarde a confirmação do nosso lado para que você possa seguir adiante.
Ativar Conexão
Recebeu a confirmação de que a sua chave pública foi configurada na Omni e o nome de usuário cadastrado? Então vamos para os próximos passos.
Configurações iniciais para ativar a conexão com a Omni.
Você encontrará um passo a passo de 12 tópicos abaixo. Até o passo de número 10 será preciso ser feito somente uma vez inicial. Quando você tiver uma atualização de tabela de produto para importar, basta executar somente os passos 11 e 12.
Então vamos, lá!
1. Abra o WinSCP, clique em Sessão > Nova Sessão. Ou pressione CTRL+N.
2. A tela abaixo será aberta.
No campo "Host" preencha: sftp.omni.chat
No campo Usuário: preencha o nome de usuário informado pela Omni.
Na sequência clique em Avançado.
3. Selecione dentro de “SHH” a opção “Autenticação”, conforme abaixo. No campo “Arquivo de Chave Privada” é onde você vai indicar para o programa onde consta a sua chave privada que, se você seguiu os passos acima, é para estar no endereço C:\users\seu_nome_de_usuário\.ssh\id_rsa. De qualquer forma, basta clicar nos três pontinhos abaixo e localizar a sua chave privada.
4. Ao selecionar a pasta provavelmente não aparecerá nenhum arquivo, mude nas opções para “Todos os Arquivos” e selecione o que consta com o ícone branco e clique em abrir, conforme print abaixo:
5. Ao clicar em abrir, será questionado se você deseja mudar o formato da chave privada de OpenSHH para PuTTY, clique em “OK” e será solicitado então um local para salvar esta chave com esse novo formato, clique em salvar na mesma pasta.
6. Retorne à pasta onde as chaves foram salvas e repare que agora existem três arquivos na sua pasta, em que o que está destacado abaixo foi o novo formato gerado:
7. Clique com o botão direito em cima deste arquivo, selecione Propriedades > Segurança > Avançadas.
8. Em Permissões, é importante que somente o seu usuário esteja listado em “Entradas de Permissão”. Para retirar os demais, clique em “desabilitar herança” e remover os demais mantendo somente o seu usuário. Após remover os demais usuários, clique em “OK” e “OK” novamente.
9. Retornando ao WinSCP, é para que você tenha a tela de configurações neste formato [com a sua chave selecionada no formato “.ppk”], clique então em OK:
10. A tela abaixo aparecerá. Clique em "salvar" e em "OK".
11. Repare que todos esses 10 passos anteriores foram salvos e um atalho foi criado à esquerda do WinSCP. Toda vez que precisar importar uma nova planilha, basta selecionar o usuário já pré-cadastrado e clicar em "login" abaixo. Clique em "Login".
12. Quando a conexão for estabelecida, você retornará para a tela inicial do WinSCP com duas áreas. Uma referente ao seu equipamento e outra referente à conexão com a Omni, como indicado abaixo:
Formato do arquivo
O formato do arquivo deve atender exatamente os requisitos abaixo:
deve ser no formato .CSV
devem usar a codificação UTF-8
as colunas devem ser delimitadas por ponto e vírgula
Essas colunas são mandatórias e sem elas a linha não será importada:
ID
Variant ID
Name
Variant Price
Criamos um template modelo para facilitar sua carga de dados.[clique aqui para acessar o template modelo].
Tabela de preço (opcional)
Você deve solicitar ao suporte da Omni o ID da tabela de preço para preencher neste arquivo .CSV antes de nos enviar. O suporte da Omni passará essa informação, basta preencher a coluna "PRICING TABLE ID" para todas as linhas. Válido somente para cada tabela de preços nova - em caso de atualização de informações ou preços de uma tabela, não se faz necessário um novo ID.
Importação
Para importar o arquivo basta procurá-lo dentro da WinSCP na “tela referente ao seu equipamento” [seu diretório] e arrastar para a “tela referente à conexão com a Omnichat” [diretório OmniChat] referenciados na imagem acima.
O seu arquivo entrará em uma fila de importação da Omni, a qual pode levar cerca de 1 à 2 horas para ser concluída.
Ao selecionar o arquivo que será importado a tela abaixo será aberta, basta clicar em OK e ao final será possível enxergar o seu arquivo transferido no diretório da Omni:
Limites
Os arquivos precisam respeitar alguns tamanhos máximos. Caso seu arquivo seja superior aos limites abaixo, entre em contato com o seu suporte da OmniChat.
Tamanho máximo do arquivo CSV: 30MB
Número máximo de linhas: 80.000
Espero que este conteúdo tenha te ajudado.
A equipe da Omni deseja boas vendas!



