SFTP - Instruções de configuração

ÍNDICE

• SFTP - Instruções de configuração
  • Hospedagem e autenticação
  • Configuração
  • Frequência e agendamento
  • Relatórios e tratamento de erros
    • Perguntas frequentes relacionadas
  • Como criar uma chave SSH pública para o servidor SFTP
    • Formato
    • Padrão
    • Criando chaves SSH 
    • Exemplo de chave
  • Instruções para tipos de registros específicos

Hospedagem e autenticação

Nós hospedamos sua pasta SFTP em um servidor SFTP dedicado (via AWS). Cada cliente terá um usuário exclusivo com acesso direto à sua própria pasta SFTP. O acesso é feito por meio de autenticação por chave. Por isso, você vai precisar criar um par de chaves (pública e privada) e informar a chave pública no campo Chave pública durante a configuração da sua pasta. A chave precisa estar no formato openSSH RSA . Para saber como criar as chaves, veja o tópico Como criar uma chave SSH pública para o servidor SFTP mais abaixo.

Configuração

1. Informe a chave pública que você criou no campo Chave pública . Se quiser, você também pode atualizar o campo Nome de usuário . O valor do campo Nome de usuário precisa começar com uma letra, número ou underline e ter entre 3 e 100 caracteres. Você pode usar letras, números, underline (_), arroba (@), ponto (.) e hífen (-).

2. Copie o Nome de usuário, URL do domínio Spotnanae o Número da porta para um local seguro, pois essas informações serão necessárias depois para a equipe responsável pelo envio dos arquivos para a nova pasta. 
   Atenção: Depois que a configuração da pasta SFTP for concluída, esses dados também ficam disponíveis em Gerenciar.

3. Informe o(s) e-mail(s) onde você deseja receber os relatórios sobre os envios de arquivos no campo Notificação por e-mail do SFTP . Para mais detalhes, confira a seção Relatórios e tratamento de erros abaixo.

4. Clique em Conectar.

Assim que a chave pública for adicionada, o status inicial ficará como Não verificado. Esse status aparece no OBT até que um arquivo seja recebido na pasta. Você pode enviar um arquivo de teste ou um arquivo real (como a carga de RH ou campos personalizados, desde que estejam em formatos aceitos). Se a chave pública for atualizada depois, o status volta para Não verificado e só muda quando um novo arquivo for recebido.

Para remover sua pasta SFTP, clique em Desconectar. Isso vai excluir sua pasta SFTP. Se precisar configurar novamente depois, será necessário informar todos os dados do início, como explicado acima.

Frequência e agendamento

Vocë define quando e com que frequência os arquivos serão enviados. O processamento começa assim que o arquivo é criado na pasta do nosso servidor SFTP. Ou seja, assim que você enviar um arquivo para sua pasta, nosso sistema já inicia o processamento. 

Para recomendações de frequência e agendamento específicas para cada tipo de registro (como usuários, campos personalizados, entidades legais), consulte a seção Frequência e agendamento nas instruções de SFTP para cada tipo de registro.

Relatórios e tratamento de erros

Coletamos informações sobre os arquivos enviados e geramos um relatório interno após cada upload. Esse relatório é enviado para o(s) e-mail(s) que você informou no campo Notificação por e-mail do SFTP durante a configuração. Para cada arquivo enviado, o relatório mostra: 

• todos os motivos pelos quais o envio do arquivo pode ter falhado (formato incorreto, colunas obrigatórias faltando, etc.).

• todos os motivos pelos quais uma linha do arquivo não pôde ser processada. Não fazemos atualizações parciais: se houver erro em uma coluna ou faltar um campo obrigatório naquela linha, a linha inteira será rejeitada. 

• o status do envio (pendente, concluído, com erro).

Vocë pode usar essas informações para corrigir eventuais erros. Se não conseguir resolver, entre em contato com o suporte técnico. 

Perguntas frequentes relacionadas

1. Podemos enviar um arquivo incremental, contendo apenas os registros que precisam ser atualizados ou incluídos?

   • Sim

2. O arquivo enviado (via SFTP ou upload manual) precisa incluir as colunas opcionais mesmo que você não as utilize?

   • Não

Como criar uma chave SSH pública para o servidor SFTP

Siga as orientações abaixo para criar a chave SSH pública que você vai nos enviar.

Formato

• Tipo: String

• Limite de caracteres: máximo de 2048.

Padrão

 ^ssh-rsa\s+[A-Za-z0-9+/]+[=]{0,3}(\s+.+)?\s*$

Criando chaves SSH 

Para criar as chaves SSH, execute este comando no prompt do Windows ou no terminal do macOS, Linux ou UNIX:

ssh-keygen -t rsa -b 4096 -f nome_da_chave

Em que: 

• -t define o tipo de criptografia

• -b define o tamanho da chave (em bits)

• -f define o nome da chave

Exemplo de chave

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDDJB9oBRPrBegMDPEQo+HmNDb/jKUJL6q2kQpNNMDjNps9mhhwJ1dP/lOavMitBPAndeXlwaNEm2XbGaSrZtD/tbQTX1HQjP6pacy+Alf8kYBm5QFfl/Z6lGC8qHys10fpRXgYE7UhdSv6VyRqt1gELGFQwVBZ2kJJuBGJF1IRywwvG/h68B8iWU1+6KEWYQoUcT45r3j3otnx4NhhzpTiNgDbMk0ix+kar4/IstobRLcb7rt7FoUerTLNrVDi69DqbsGY5LN+NM8jVx0sPQLRC/ruil8pTHP3k4rDCc7a80+sH4sUTW+mHc7MTqbi/CcyyFAD8h7p6WqxEydOaJjMnvqAbE17BOj0TSxv3HMohTf3skzE7PbzVcjIfHTpFPGxmJkghAYAMi5l9VvAs91IpVylxjqPss3xQQJIZEmQdG2k7zk/UpsUFlmaOj6lCHRicFKCixKekzzm3nFuJvDEklurtydOQjZ8WkPzTSJfZBdKMuMUi0SQ9m9ZAw99t0=

Instruções para tipos de registros específicos

Para orientações detalhadas sobre como enviar tipos de registros específicos via SFTP, consulte os tópicos abaixo:

• Cargas de RH (usuários)
• Papéis
• Campos personalizados
• Escritórios
• Entidades legais