Ir para o conteúdo

Integração via SFTP

O que é SFTP?

SFTP é um jeito seguro de transferir arquivos pela internet entre computadores. Ele funciona como um túnel protegido, garantindo que ninguém consiga acessar ou alterar os arquivos enquanto eles estão sendo enviados. É muito usado para compartilhar informações sensíveis ou confidenciais.

Credenciais

As credenciais de acesso serão fornecidas pela equipe técnica e devem ser solicitadas através de nossos canais de atendimento.

Permissão de conexão

Por questões de segurança o ambiente não está liberado de forma pública na internet. Durante a configuração de seus acessos, será necessário informar o IP público do seu ambiente para liberação.

Ambientes

Produção

Informações Valor
Endereço sftp.vehub.com.br
Porta 2222
Protocolo SFTP

Homologação

Informações Valor
Endereço sftp.dev.vehub.com.br
Porta 2222
Protocolo SFTP

Estrutura de pastas

📁 CNAB

Pasta destinada ao envio de arquivos de entrada.

Reenviar um arquivo com o mesmo conteúdo de um já processado é recusado, exceto quando a importação anterior está Rejeitada ou Cancelada (títulos excluídos pelo cancelamento do lote).

📁 BANCO

Pasta destinada ao envio de arquivos de retorno bancário.

📁 NFE

Pasta destinada ao envio de arquivos de lastro.

📁 CANHOTO

Pasta destinada ao envio de canhotos (comprovantes de entrega) de NF-e. Formatos aceitos: pdf, jpg, jpeg e png.

Convenção de nome de arquivo: os 44 dígitos da chave de acesso da NF-e devem ser o prefixo do nome, separados de qualquer sufixo por _. Exemplos válidos:

12345678901234567890123456789012345678901234_001.pdf
12345678901234567890123456789012345678901234_nomeempresa_pag1.jpg

Como funciona:

  1. A chave de acesso é extraída do início do nome do arquivo.
  2. Todos os títulos da operação cujo lastro principal tenha a mesma chaveNfe recebem o canhoto como documento adicional (TipoLastro.Canhoto), vinculado a cada parcela.
  3. O lastro principal (XML da NF-e) não é alterado; o canhoto fica como documento adicional separado.
  4. Se nenhum título for encontrado com a chave informada, o arquivo é rejeitado e registrado no Log de Integração.
  5. Reenvio do mesmo arquivo (mesmo conteúdo) é recusado. Um arquivo diferente do mesmo canhoto vira um segundo documento adicional.

Pré-condição

O título com a chave da NF-e deve estar cadastrado antes do envio do canhoto. Não há fila de espera para canhotos recebidos antes do título.

📁 RETORNO

Pasta em que o VeHub irá postar os arquivos de retorno para o cliente.