Saltar para o conteúdo
Conceitos e arquitetura

Conceitos e arquitetura

O Riversoft® STCP DirectLink é o produto de transferência gerenciada de arquivos (MFT) da Riversoft para pessoas, sistemas e parceiros:

  • Pessoas: portal web, pelo navegador.
  • Sistemas: API REST.
  • Parceiros: SFTP, AS2 e Webhook.
  • Outros destinos: WhatsApp e armazenamento em nuvem (Amazon S3, Azure Blob Storage, Google Cloud Storage e Oracle Cloud Object Storage).

Para trocas pelo protocolo OFTP, use o Riversoft STCP Gemini. Os dois produtos podem ser usados juntos ou separadamente e compartilham a gestão pelo Riversoft Console Portal e as caixas postais.

Arquitetura

O Riversoft STCP Gemini e o Riversoft STCP DirectLink são produtos independentes, que podem ser usados juntos ou separadamente. Os dois são configurados e monitorados pelo Riversoft Console Portal e pela Riversoft STCP Gemini API, e a configuração, os registros e o histórico das transferências ficam no banco de dados da sua empresa.

    flowchart LR
    ADM[Administrador] -->|HTTPS| PORTAL[Riversoft Console Portal]
    SIS[Sistemas externos] -->|HTTPS / REST| API[Riversoft STCP Gemini API]
    PORTAL --> API
    API --> DB[(Banco de configuração<br/>e banco de log)]
    SRV[Riversoft STCP Gemini Server] --> DB
    DL[Riversoft STCP DirectLink] --> DB
    REN[Riversoft STCP Gemini Rename] --> DB
    SRV <-->|OFTP| PARC[Parceiros]
    DL <-->|SFTP, AS2, HTTPS, Webhook,<br/>S3, Azure Blob, GCS, OCI| PARC
    SRV -->|eventos| REN
  
PartePapel
TransferênciaO Riversoft STCP Gemini Server troca arquivos com os parceiros pelo OFTP; o Riversoft STCP DirectLink, pelos demais protocolos e conectores.
GestãoO Riversoft Console Portal e a Riversoft STCP Gemini API criam e alteram instâncias, usuários, serviços de rede e agendamentos, e acompanham as transferências.
Banco de dadosGuarda a configuração (banco de configuração) e o histórico das transferências (banco de log).
Caixas postaisDiretórios de cada usuário, onde ficam os arquivos a enviar e os recebidos. Veja Caixa postal e diretórios.
AutomaçãoO Riversoft STCP Gemini Rename e o roteamento interno do Riversoft STCP DirectLink encaminham os arquivos de acordo com as regras.

Componentes

ComponenteFunçãoPacote
Riversoft STCP DirectLinkTransfere arquivos por todos os protocolos e conectores além do OFTP e oferece a API REST (/directlink/v2), documentada em Riversoft STCP DirectLink API.stcpdirectlink
Riversoft STCP DirectLink PortalInterface web para login, upload e download de arquivos. Veja Uso do Riversoft STCP DirectLink Portal.stcpdirectlink-portal
Riversoft Console PortalInterface web de configuração e monitoramento do Riversoft STCP DirectLink e do Riversoft STCP Gemini. É servida pela Riversoft STCP Gemini API.stcpgemini-portal
Riversoft STCP Gemini APIAPI REST de gestão do Riversoft STCP DirectLink e do Riversoft STCP Gemini. Veja Riversoft STCP Gemini API.stcpgemini-api
Riversoft STCP Gemini Rename (opcional)Roteamento e automação de arquivos. Veja Riversoft STCP Gemini Rename.stcpren
Riversoft STCP Gemini (opcional)Transferências pelo protocolo OFTP. Veja Riversoft STCP Gemini.stcpgemini-server
Riversoft STCP Enterprise Server (opcional)No Windows, mantém usuários, credenciais, regras e áreas de arquivos.—
Provedor de identidade (opcional)Google, Microsoft, Apple ou outro provedor OAuth 2.0 e 2.1/OpenID Connect ou SAML 2.0 usado no SSO.—
Cloudflare Turnstile (opcional)Verificação contra automação no login, no primeiro acesso e na recuperação de senha.—

Protocolos e conectores

O Riversoft STCP DirectLink atende pessoas, sistemas e parceiros, cada um pelo meio mais adequado:

    flowchart LR
    U[Usuário no navegador] -->|HTTPS| P[Riversoft STCP DirectLink Portal]
    S[Sistema integrado] -->|HTTPS / API REST| A[Riversoft STCP DirectLink]
    PS[Portal de serviços] -->|Token exchange JWT| A
    IdP[Provedor de identidade] -.->|SSO OAuth 2.0 / SAML 2.0| A
    P --> A
    PARC[Parceiros] <-->|SFTP, AS2, Webhook| A
    A <-->|S3, Azure, GCS, OCI| N[Armazenamento em nuvem]
    A -.->|e-mail, SMS, WhatsApp| D[Destinatário externo]
    G[Riversoft Console Portal e<br/>Riversoft STCP Gemini API] -->|configura e monitora| A
  
QuemComo acessaDireção
PessoasRiversoft STCP DirectLink Portal, pelo navegador, com login, SSO e MFA.Envio e recebimento
Sistemas da empresaAPI REST, com token Bearer ou token exchange.Envio e recebimento
ParceirosSFTP, AS2 ou Webhook, com o Riversoft STCP DirectLink como servidor.Envio e recebimento
Servidores dos parceiros e nuvemConectores de saída: SFTP, AS2, FTPS/FTP, Webhook, WhatsApp, Amazon S3, Azure Blob Storage, Google Cloud Storage e Oracle Cloud Object Storage.Envio e coleta
Destinatários externosLink seguro enviado por e-mail, SMS ou WhatsApp, protegido por código de segurança.Recebimento

A tabela abaixo mostra qual produto atende cada protocolo ou conector. Os detalhes estão em Protocolos e conectores.

Conector / protocoloServidorClienteProduto
OFTP 1.x e OFTP 2.0✓✓Riversoft STCP Gemini
SFTP✓✓Riversoft STCP DirectLink (cliente legado também no Riversoft STCP Gemini Server)
AS2✓✓Riversoft STCP DirectLink
HTTPS (portal web e API REST)✓—Riversoft STCP DirectLink
Webhook✓✓Riversoft STCP DirectLink
WhatsApp—✓Riversoft STCP DirectLink
FTPS / FTP—✓Riversoft STCP DirectLink
Amazon S3, Azure Blob Storage, Google Cloud Storage, Oracle Cloud Object Storage—✓Riversoft STCP DirectLink

Nota

Outros conectores podem estar disponíveis conforme a versão e a configuração. Veja Protocolos e conectores do Riversoft STCP DirectLink.

Como funciona uma transferência

Envio e recebimento pela API

As rotas protegidas exigem um token Bearer. A senha é apresentada uma única vez, na obtenção do token.

    sequenceDiagram
    autonumber
    participant App as Aplicação cliente
    participant DL as API Riversoft STCP DirectLink
    App->>DL: POST /oauth2/token (password grant ou token exchange)
    DL-->>App: access_token (Bearer)
    App->>DL: POST /upload (Authorization: Bearer)
    DL-->>App: Upload confirmado
    App->>DL: GET /download/list (Authorization: Bearer)
    DL-->>App: Lista de arquivos com linkURL (link seguro)
    App->>DL: GET linkURL (/download/file?...) com token Bearer
    DL-->>App: Conteúdo do arquivo e header X-STCPDIRECTLINK-HASH
    Note over DL: O arquivo é movido para a área de backup
  

O destino de um arquivo enviado depende do que é informado no upload:

UploadDestino do arquivo
Sem destino nem destinatárioDiretório entrada da caixa postal do próprio usuário.
Com um usuário de destino (header X-STCPDIRECTLINK-DESTINATION)Diretório saida da caixa postal do usuário de destino, que passa a vê-lo na área de download.
Com e-mail ou celular de destinatárioÁrea de link seguro do usuário (saida/link); o destinatário recebe o link. Veja Link seguro.

A lista de download mostra os arquivos do diretório saida. Depois do download, o arquivo é movido para a área de backup (saida/backup).

Link seguro para destinatários externos

Ao enviar um arquivo, é possível informar o e-mail ou o celular de um destinatário. Ele recebe um link seguro para download, que identifica o e-mail ou celular vinculado ao arquivo e só libera o download com um código de segurança (PIN).

    sequenceDiagram
    autonumber
    participant R as Remetente
    participant DL as Riversoft STCP DirectLink
    participant D as Destinatário
    R->>DL: Upload com e-mail ou celular do destinatário
    DL->>D: Link seguro (e-mail, SMS ou WhatsApp)
    D->>DL: Abre o link
    DL->>D: Código de segurança (somente para o e-mail ou celular vinculado)
    D->>DL: Informa o código dentro do prazo de validade
    DL-->>D: Download do arquivo
  

Importante

O código de segurança é enviado somente ao e-mail ou celular vinculado ao arquivo. Por padrão, o link de download vale 24 horas e o PIN, 180 segundos; o administrador pode alterar esses prazos. Veja Segurança.

Autenticação por JWT de confiança

Portais de serviços podem autenticar seus usuários no Riversoft STCP DirectLink trocando um token JWT, assinado pela chave privada do portal, por um token Bearer do Riversoft STCP DirectLink (token exchange). O Riversoft STCP DirectLink valida o JWT com a configuração do provedor JWT cadastrada pelo administrador. O fluxo completo está em Segurança.

Conexões de entrada e de saída

ConexãoQuem iniciaQuando
EntradaPessoas pelo portal, sistemas pela API e parceiros por SFTP, AS2 ou Webhook.Quando o usuário decidir, dentro das suas regras.
SaídaO Riversoft STCP DirectLink conecta ao servidor do parceiro ou à nuvem pelos conectores.Por agendamento, nas datas ou intervalos definidos. Pelo Riversoft Console Portal, o operador também pode executar uma agenda na hora ou iniciar uma conexão de saída com um usuário.
SupervisãoA Riversoft STCP Gemini API conecta ao serviço Supervisão (directlink) do Riversoft STCP DirectLink (porta padrão 33060).Sempre que o Riversoft Console Portal acompanha ou opera a instância. Veja Serviços de supervisão.

Caixa postal e diretórios

Cada usuário tem uma caixa postal no diretório de dados (DataDirectory, por padrão /usr/local/stcp/data), no caminho <DataDirectory>/<instância>/<usuário>/. O Riversoft STCP Gemini e o Riversoft STCP DirectLink usam exatamente a mesma estrutura de caixas postais:

<DataDirectory>/<instância>/<usuário>/
├── entrada/
│   └── restart/
├── saida/
│   ├── backup/
│   ├── pendente/
│   └── link/
├── controle/
├── formato/
└── temp/
    flowchart LR
    SIS[Sistema da empresa] -->|grava| SAI[saida]
    SAI -->|transmitido ou baixado| BKP[saida/backup]
    BKP -.->|retransmissão| SAI
    PARC[Parceiro ou usuário] -->|envia| ENT[entrada]
    ENT -->|lido por| SIS
  
DiretórioNo Riversoft STCP GeminiNo Riversoft STCP DirectLink
entradaArquivos recebidos do parceiro pelo OFTP.Arquivos recebidos por upload no portal ou na API e pelos protocolos e conectores.
entrada/restartInformações de retomada das transferências interrompidas.Informações de retomada das transferências interrompidas.
saidaArquivos a transmitir ao parceiro.Arquivos disponíveis para download (área de download) e a transmitir pelos conectores.
saida/backupArquivos já transmitidos. Um arquivo pode voltar para saida para ser retransmitido.Arquivos já baixados (área de backup).
saida/pendenteControle de EERP: confirmações de recepção aguardando envio.—
saida/link—Arquivos disponíveis por link seguro para destinatários externos.
controleArquivos de controle das transferências, como EERP, NERP e locks.Arquivos de controle das transferências.
formato e tempDefinições de formato e arquivos temporários.Definições de formato e arquivos temporários.

Os nomes dos diretórios são configuráveis na instância. Veja Diretórios de dados.

Áreas de arquivos

Na interface do Riversoft STCP DirectLink, cada usuário vê três áreas da sua caixa postal:

ÁreaDiretórioConteúdo
DownloadsaidaArquivos disponíveis para o usuário receber.
Backupsaida/backupArquivos já baixados. Um arquivo é movido da área de download para a de backup logo após o download e permanece nela conforme as políticas de retenção configuradas.
Link segurosaida/linkArquivos enviados a destinatários externos por link seguro.

Regras aplicadas a cada transferência

Antes de aceitar um envio ou liberar um download, o Riversoft STCP DirectLink valida a operação contra as regras do usuário:

RegraEfeito
Bloqueio do usuárioUm usuário bloqueado não troca arquivos.
Janela de horárioAs transferências só são aceitas nos dias e horários permitidos.
Filtros de arquivoNome e tamanho do arquivo precisam atender aos filtros do usuário.
Programa externo de validaçãoQuando configurado, um programa da empresa aprova ou recusa o arquivo.
Validação do hostA API recusa chamadas feitas por um host diferente do configurado.
IntegridadeO upload pode ser validado pelo hash SHA-256 do arquivo.

Cada operação, aceita ou recusada, é registrada. Veja Segurança.

Roteamento e automação

Com o roteamento habilitado, o Riversoft STCP DirectLink examina periodicamente os diretórios configurados e encaminha cada arquivo encontrado conforme uma tabela de distribuição (CSV), que relaciona a origem do arquivo aos destinos e aos destinatários.

    flowchart LR
    ARQ[Arquivo encontrado<br/>no diretório] --> TAB{Tabela de<br/>distribuição}
    TAB -->|cópia| DEST[Diretório de destino]
    TAB -->|link| LINK[Link seguro para<br/>os destinatários]
    TAB -->|comando externo| CMD[Programa da empresa]
    TAB --> BKP[Backup do original]
  
EtapaO que acontece
IdentificaçãoA origem e o nome do arquivo são extraídos do nome por uma expressão regular.
EncaminhamentoConforme a tabela, o arquivo é copiado para o destino, gera um link seguro para os destinatários ou é entregue a um comando externo.
FinalizaçãoO original é movido para o backup ou removido, conforme a configuração.

Para regras de renomear, copiar, mover e distribuir mais elaboradas, use o Riversoft STCP Gemini Rename. Os parâmetros estão em Configuração › Roteamento e distribuição.

Registro e monitoramento

RecursoDescrição
Banco de logCada envio, download e acesso é registrado com usuário, arquivo, data, hora e resultado, quando o registro no banco está habilitado (logDbEnable).
Eventos e mensagensCada ocorrência gera um evento e uma mensagem com código (MSGnnnn).
RelatóriosA API oferece relatórios das transferências do usuário. Veja Riversoft STCP DirectLink API.
TelemetriaLogs, métricas e traces são exportados no padrão OpenTelemetry. Veja Telemetria.
SupervisãoO Riversoft Console Portal acompanha os usuários e as transferências.

Veja Monitoramento e auditoria.

Conceitos-chave

ConceitoDescrição
UsuárioPessoa, sistema ou parceiro que troca arquivos. Cada usuário tem uma única caixa postal, a mesma usada pelo Riversoft STCP Gemini.
Área de downloadArquivos disponíveis para o usuário receber (diretório saida).
Área de backupArquivos já baixados (diretório saida/backup).
ConectorLigação com um protocolo ou serviço externo, como SFTP, AS2, FTPS, Webhook, WhatsApp ou armazenamento em nuvem (Amazon S3, Azure Blob Storage, Google Cloud Storage ou Oracle Cloud Object Storage).
AgendamentoExecução das conexões de saída em datas ou intervalos definidos. A agenda também pode ser executada na hora pelo Riversoft Console Portal.
Link seguroLink de download enviado a um destinatário externo por e-mail, SMS ou WhatsApp.
Código de segurançaPIN enviado ao destinatário do link seguro para liberar o download.
Token BearerCredencial exigida nas rotas protegidas da API, obtida no login.
Token exchangeTroca de um JWT de um portal de confiança por um token Bearer.
Tabela de distribuiçãoArquivo CSV que relaciona origens, destinos e destinatários no roteamento.

Outros termos estão no Glossário.