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
    • FAQs relacionadas
  • Como criar uma chave SSH pública para o servidor SFTP
    • Formato
    • Padrão
    • Criando chaves SSH
    • Chave de exemplo
  • Instruções para tipos de registro específicos

Hospedagem e autenticação

Hospedamos sua pasta SFTP em um servidor SFTP dedicado (via AWS). Cada cliente terá uma conta de usuário exclusiva com acesso direto à sua pasta SFTP específica. Oferecemos suporte à autenticação baseada em chave. Por isso, você precisará criar um par de chaves pública e privada e inserir a chave pública no campo Chave pública ao configurar sua pasta. A chave deve estar no formato openSSH RSA. Para criar as chaves, consulte Como criar uma chave SSH pública para o servidor SFTPabaixo.

Configuração

1. Insira a chave pública que você criou no campo Chave pública. Você pode, se desejar, atualizar o campo Nome de usuário. O valor no campo Nome de usuário deve começar com uma letra, dígito ou sublinhado e ter entre 3 e 100 caracteres. Pode conter letras, dígitos, sublinhados, arrobas (@), pontos (.) e hifens (-).

2. Copie os valores de Nome de usuário, URL do domínio Spotnana e Número da porta em um local seguro, pois serão necessários posteriormente pela equipe da sua organização responsável pelo envio de arquivos para a nova pasta criada. 
   Observação: Após a configuração da pasta SFTP, esses valores poderão ser acessados novamente em Gerenciar.

3. Insira o(s) endereço(s) de e-mail onde você deseja receber relatórios sobre seus envios de arquivos no campo Notificação por e-mail SFTP. Para mais detalhes, consulte Relatórios e tratamento de erros abaixo.

4. Clique em Conectar.

Assim que uma chave pública for adicionada, o status inicial será definido como Não verificado. Esse será o status exibido no OBT até que um arquivo real seja recebido na pasta. O arquivo enviado pode ser um arquivo de teste de sua escolha ou um arquivo real de HR feed ou campo personalizado (apenas arquivos em formatos suportados serão processados). Além disso, se a chave pública for posteriormente atualizada, o status será redefinido para Não verificado até que o próximo arquivo seja recebido.

Para remover sua pasta SFTP, clique em Desconectar. Isso removerá sua pasta SFTP. Se precisar configurá-la novamente depois, será necessário inserir todas as informações descritas acima desde o início.

Frequência e agendamento

Você define o agendamento e a frequência dos envios de arquivos. Utilizamos o gatilho de criação do objeto de arquivo para iniciar o processamento. Isso significa que, assim que você enviar um arquivo para sua pasta em nosso servidor SFTP, nosso aplicativo começará a processar o upload.

Para recomendações específicas de frequência e agendamento 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

We collect data on your file uploads and use it to create an internal report after each file upload. This report is sent to the email address(es) you provided in the SFTP email notification field during setup. For each file uploaded, the report will contain: 

• quaisquer motivos pelos quais um envio de arquivo falhou (formato incorreto, nomes de colunas ausentes etc.).

• quaisquer motivos pelos quais uma linha dentro de um arquivo não pôde ser enviada. Não realizamos atualizações parciais e a linha será rejeitada se ocorrer um erro em uma coluna específica ou se um campo obrigatório estiver ausente nessa linha.

• o status do envio (pendente, bem-sucedido, falhou).

Você pode usar o conteúdo desse arquivo para solucionar quaisquer erros. Se não conseguir corrigir o erro, entre em contato com o suporte técnico.

Perguntas frequentes relacionadas

1. Aceitamos um arquivo incremental que contenha apenas os registros que precisam ser atualizados ou adicionados?

   • Sim

2. O arquivo que você enviar (seja por SFTP ou upload manual) precisa incluir as colunas opcionais mesmo que não estejam em uso?

   • Não

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

Siga as instruções abaixo para criar a chave SSH pública que deverá ser fornecida para nós.

Formato

• Tipo: String

• Restrições de comprimento: máximo de 2048 caracteres.

Padrão

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

Criando chaves SSH

Para criar chaves SSH, execute o comando abaixo na linha de comando do Windows ou no terminal do macOS, Linux ou UNIX:

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

Onde

• -t é o tipo de criptografia

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

• -f é o nome do arquivo 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 obter instruções detalhadas sobre o envio de tipos específicos de registros via SFTP, consulte os tópicos abaixo:

• Feeds de RH (usuários)
• Campos personalizados
• Escritórios
• Entidades legais