Riversoft STCP Gemini API
Riversoft STCP Gemini API
Version 3.10.0
The Riversoft STCP Gemini API is the management REST API for Riversoft® STCP Gemini and Riversoft STCP DirectLink. It is the same API used by the Riversoft Console Portal, open to integrations with other systems and providers: configure the environment, manage operators and permissions, supervise the instances and query reports.
The API follows the HTTP/REST model and receives and responds in JSON.
Note
To send and receive files by API, use the Riversoft STCP DirectLink API, dedicated to file transfer.
Main features
| Feature | What you can do |
|---|---|
| Authentication | Sign-in with 2FA, password grant, LDAP, Single Sign-On (SAML 2.0 and OAuth 2.0) and logout. |
| Configuration | Manage instances, users, network services, schedules, file types and routings. |
| Administration | Manage operators, groups and permissions, the API registration and the error and event codes. |
| Supervision and maintenance | Query and command the instances, run schedules, start connections, manage test files and keys, and reset password, 2FA and lock. |
| Reports | Query events, operator activities, transfer history, statistics and audit. |
General information
| Property | Value |
|---|---|
| Product version | 3.10.0 |
| Base URL | https://{host}:{port} (sample default port: 33070) |
| Protocol | HTTPS (recommended; enabled in ssl in the API config.json) |
| Format | JSON; body with Content-Type: application/json, exactly |
| Authentication | Bearer token: sign-in with 2FA, password grant, LDAP or SSO |
| Specification | OpenAPI 3.0.3 in Portuguese, English and Spanish |
The {host} and {port} are the ones configured in the general section of the API config.json. See Riversoft STCP Gemini configuration.
Where to start
Obtain a token and query your first report.
Choose the operator authentication method.
Resource management and report queries.
Endpoints, parameters, responses and codes.
How this documentation is organized
| Section | What for |
|---|---|
| Concepts | Understand the managed resources, permissions and pagination before integrating. |
| Quick start | Obtain the first token and make the first query. |
| Security | Best practices for TLS, credentials, tokens and audit. |
| Authentication | Step by step for each authentication method. |
| Guides | Complete management and report query tasks. |
| Troubleshooting | Common symptoms and how to solve them. |
| Reference | Contract of each endpoint, CONFIG_TXT structure and codes. |
| Release notes | New features, fixes and breaking changes by version. |
Example conventions
- The examples use
curland the illustrative hostapi.example.com. Replace it with your environment’s host and port. - Values between
<and>in code blocks are placeholders to replace, not literal values. - The examples read passwords and codes with
read -sso that they do not stay in the shell history. - Response examples show the field format. Actual values depend on the environment.
- Dates in report filters are Unix timestamps in milliseconds.