Saltar para o conteúdo

Webhook

No Riversoft® STCP DirectLink, Webhook é a troca de documentos com parceiros por HTTP/HTTPS. Cada lado da troca tem um papel:

ComponenteQuem inicia a conexãoFunção
Conector WebhookO Riversoft STCP DirectLink (conexão de saída)Envia os documentos do usuário ao endpoint HTTP/HTTPS do parceiro.
Serviço Webhook DirectLinkO parceiro (conexão de entrada)Recebe os documentos que o parceiro envia ao Riversoft STCP DirectLink.

No Webhook, cada conexão leva os documentos em um único sentido. Para que o parceiro também envie documentos, ele se conecta ao serviço Webhook DirectLink.

Conexões de saída (conector Webhook)

    flowchart LR
    subgraph DL[Riversoft STCP DirectLink]
      SA["Diretório saida"]
      C[Conector Webhook]
    end
    SA --> C
    C -->|documento e headers| P[Endpoint do parceiro]
  

O Riversoft STCP DirectLink entrega ao endpoint do parceiro, em uma requisição HTTP/HTTPS, cada documento disponível na caixa postal do usuário (diretório saida), por agendamento ou quando o operador inicia a conexão no Riversoft Console Portal. O retorno do parceiro fica registrado no log da transferência.

RecursoDescrição
EndpointURL do parceiro que recebe os documentos.
IdentificaçãoIdentificador do remetente e do destinatário da troca, definidos no cadastro do usuário.
AutenticaçãoNenhuma, Basic ou Bearer, conforme exigido pelo parceiro, com as credenciais protegidas no cadastro.
Assinatura e criptografiaAssinatura com o certificado e a chave do Riversoft STCP DirectLink e criptografia com o certificado do parceiro, com o algoritmo combinado.
Headers customizadosHeaders fixos definidos no cadastro do usuário e headers por arquivo, informados nos metadados do arquivo.
TLSValidação do certificado do parceiro, CA própria e certificado de cliente (mTLS).
RedeA conexão pode sair por um proxy e por um endereço local específico.
TimeoutTempo máximo de cada envio.

O conector Webhook só envia documentos: ele não lista, não baixa e não remove arquivos no parceiro.

Conexões de entrada (serviço Webhook DirectLink)

    flowchart LR
    subgraph DL[Riversoft STCP DirectLink]
      S[Serviço Webhook DirectLink]
      EN["Diretório entrada"]
    end
    Q[Sistema do parceiro] -->|documento e autenticação| S
    S --> EN
  

O parceiro envia documentos ao endpoint do serviço Webhook DirectLink. Cada requisição é autenticada, associada a um usuário e gravada no diretório entrada da caixa postal dele.

AutenticaçãoValidação
NenhumaSomente para ambientes controlados.
BasicUsuário e senha do Riversoft STCP DirectLink.
BearerSomente token de impersonação registrado para o usuário; o sub do token deve corresponder à identificação do parceiro.

Além da credencial, o destinatário informado na requisição (header X-To) precisa corresponder à identificação cadastrada para o parceiro. O serviço aceita TLS com versão mínima e máxima configuráveis e autenticação de cliente por certificado (mTLS).

O serviço Webhook DirectLink é cadastrado nos serviços de rede da instância, no Riversoft Console Portal: endereço, porta, TLS e o endereço público do serviço.

O que combinar com o parceiro

ItemDescrição
EndereçosURL do endpoint do parceiro e URL pública do serviço Webhook DirectLink.
IdentificaçõesIdentificadores do remetente e do destinatário nos dois sentidos.
AutenticaçãoBasic ou Bearer, nos dois sentidos.
CertificadosCertificados de assinatura e de criptografia, quando usados, e os algoritmos.
HeadersHeaders que o parceiro espera receber.

Segurança

  • Publique o serviço Webhook DirectLink somente por HTTPS e, sempre que possível, exija mTLS do parceiro.
  • Prefira Bearer com token de impersonação ou Basic a nenhuma autenticação; guarde as credenciais em um cofre de segredos.
  • Use assinatura e criptografia quando o parceiro suportar.
  • Mantenha a validação do certificado do parceiro habilitada no conector.