REST API
Riversoft® STCP DirectLink provides a REST API so applications can send and receive files without manual intervention, with the same controls as Riversoft STCP DirectLink Portal: authentication, download and backup areas, secure links and traceability.
The complete API documentation (concepts, authentication, guides, endpoint reference and OpenAPI specification) lives in its own section, Riversoft STCP DirectLink API.
When to use the API
| Scenario | Example |
|---|---|
| System-to-system integration | An ERP sends invoices and receives responses automatically. |
| Delivery to external recipients | An application sends the file and the recipient gets a secure link by email, SMS or WhatsApp. |
| Service portals | A third-party portal authenticates the user through SSO or a trusted JWT and redirects them to Riversoft STCP DirectLink. |
| Auditing | A monitoring system queries the transfer report. |
Getting started
| Item | Value |
|---|---|
| Base URL | https://<domain>/directlink/v2 |
| Transport | HTTPS |
| Response format | JSON (binary content for downloads) |
| API version | v2, given in the path and in the apiver field of responses |
| Specification | OpenAPI 3.0.3, in Portuguese, English and Spanish |
API documentation
| To | See |
|---|---|
| Make your first calls | Quick start |
| Choose an authentication method (Basic, OAuth 2.0, JWT, SSO, MFA) | Authentication |
| Send, receive and share files | Guides |
| Look up endpoints, data models and codes | API reference |
| Download the OpenAPI file | OpenAPI specification |
Authentication in version 9
Protected API routes (upload, listings, report and sign-out) require a Bearer token. Basic authentication is accepted only at sign-in. See Security › API authentication.
Postman collection
To simplify development and testing, use the Postman collection with the API calls. It automatically stores the token it obtains in the token variable, which the other requests use.