Riversoft STCP DirectLink API

Versão 2

A Riversoft STCP DirectLink API permite que suas aplicações troquem arquivos com o Riversoft® STCP DirectLink sem intervenção manual: autenticar usuários, enviar arquivos, listar e baixar arquivos disponíveis, compartilhar arquivos por links seguros e consultar o histórico de transferências.

A API segue o modelo HTTP/REST, recebe formulários e arquivos e responde em JSON (ou com o conteúdo binário do arquivo, nos downloads).

Nota

Para o uso do Riversoft STCP DirectLink Portal, a arquitetura e a operação do produto, consulte a documentação do Riversoft STCP DirectLink.

Principais recursos

Recurso	O que você pode fazer
Autenticação	Login com usuário e senha (HTTP Basic), MFA, tokens OAuth, troca de JWT e Single Sign-On (OAuth 2.0 e 2.1/OpenID Connect e SAML 2.0).
Envio de arquivos	Enviar arquivos por `multipart/form-data` ou corpo binário, com destinatário e metadados opcionais.
Recebimento de arquivos	Listar os arquivos disponíveis (inclusive na área de backup) e baixá-los por links assinados.
Links compartilhados	Entregar arquivos a destinatários por links seguros, com ou sem PIN.
Relatórios	Consultar os registros de transferência por período, direção e nome de arquivo.

Informações gerais

Propriedade	Valor
Versão da API	`v2`
URL base	`https://{host}/directlink/v2`
Protocolo	HTTPS (obrigatório em produção)
Formato das respostas	JSON; conteúdo binário nos downloads
Autenticação	HTTP Basic (login), Bearer token ou cookie de sessão, SSO
Especificação	OpenAPI 3.0.3 em português, inglês e espanhol

O {host} é o endereço do Riversoft STCP DirectLink do seu ambiente, informado pelo administrador do serviço.

Importante

A partir do Riversoft STCP DirectLink 9.0.1, a API atende somente na versão v2. Se a sua integração usa a v1, veja Migração da v1 para a v2.

Por onde começar

Início rápido

Da verificação de disponibilidade ao primeiro upload e download.

Autenticação

Escolha o método de autenticação da sua integração.

Guias

Envio, recebimento, compartilhamento e relatórios.

Referência da API

Endpoints, parâmetros, modelos e códigos de resposta.

Organização desta documentação

Seção	Para quê
Conceitos	Entender URL base, credenciais, sessões, links seguros e regras de acesso antes de integrar.
Início rápido	Fazer as primeiras chamadas em poucos minutos.
Segurança	Boas práticas para proteger credenciais, tokens e links.
Autenticação	Passo a passo de cada método de autenticação.
Guias	Tarefas completas de transferência de arquivos e consulta.
Solução de problemas	Sintomas comuns e como resolvê-los.
Referência	Contrato de cada endpoint, modelos de dados e códigos.

Convenções dos exemplos

Os exemplos usam curl e o host ilustrativo api.exemplo.com. Substitua pelo host do seu ambiente.
Valores entre < e > nos blocos de código são marcadores a substituir, não valores literais.
Os exemplos leem senhas, PINs e tokens com read -s para que não fiquem no histórico do shell.
Os exemplos de resposta mostram o formato dos campos. Os valores reais dependem do ambiente.