Riversoft STCP DirectLink API

Version 2

The Riversoft STCP DirectLink API lets your applications exchange files with Riversoft® STCP DirectLink without manual intervention: authenticate users, send files, list and download available files, share files through secure links, and query the transfer history.

The API follows the HTTP/REST model, accepts forms and files, and responds in JSON (or with the binary file content, for downloads).

Note

For Riversoft STCP DirectLink Portal, the product architecture and day-to-day operation, see the Riversoft STCP DirectLink documentation.

Key features

Feature	What you can do
Authentication	Log in with user and password (HTTP Basic), MFA, OAuth tokens, JWT exchange, and Single Sign-On (OAuth 2.0 and 2.1/OpenID Connect and SAML 2.0).
Sending files	Send files as `multipart/form-data` or as a binary body, with an optional recipient and metadata.
Receiving files	List the available files (including in the backup area) and download them through signed links.
Shared links	Deliver files to recipients through secure links, with or without a PIN.
Reports	Query transfer records by period, direction, and file name.

General information

Property	Value
API version	`v2`
Base URL	`https://{host}/directlink/v2`
Protocol	HTTPS (required in production)
Response format	JSON; binary content for downloads
Authentication	HTTP Basic (login), Bearer token or session cookie, SSO
Specification	OpenAPI 3.0.3 in Portuguese, English, and Spanish

{host} is the Riversoft STCP DirectLink address of your environment, provided by the service administrator.

Important

Starting with Riversoft STCP DirectLink 9.0.1, the API is served only in version v2. If your integration uses v1, see Migration from v1 to v2.

Where to start

Quickstart

From the availability check to your first upload and download.

Authentication

Choose the authentication method for your integration.

Guides

Sending, receiving, sharing, and reports.

API reference

Endpoints, parameters, models, and response codes.

How this documentation is organized

Section	Use it to
Concepts	Understand the base URL, credentials, sessions, secure links, and access rules before you integrate.
Quickstart	Make your first calls in a few minutes.
Security	Follow best practices to protect credentials, tokens, and links.
Authentication	Follow step-by-step instructions for each authentication method.
Guides	Complete file transfer and query tasks.
Troubleshooting	Find common symptoms and how to resolve them.
Reference	Look up the contract of each endpoint, data models, and codes.

Example conventions

The examples use curl and the illustrative host api.example.com. Replace it with the host of your environment.
Values between < and > in code blocks are placeholders to replace, not literal values.
The examples read passwords, PINs, and tokens with read -s so they do not stay in the shell history.
The response examples show the format of the fields. Actual values depend on the environment.