OpenAPI specification
The formal contract of the Riversoft® STCP Gemini API is available in OpenAPI 3.0.3 format, compatible with Swagger UI, Postman, Insomnia and OpenAPI client generators. It covers every endpoint used by the Riversoft Console Portal, which are also available for integration with other systems.
Download
| Language | File |
|---|---|
| Português | openapi.pt.yaml |
| English | openapi.en.yaml |
| Español | openapi.es.yaml |
The three versions have the same endpoints, methods, parameters, operationId, schemas, authentication rules and examples. The language changes only summaries, descriptions and group names; it does not change the language of the API responses.
Contents
| Group | Endpoints |
|---|---|
| Authentication and Single Sign-On | Token issuance, sign-in with 2FA (TOTP), sign-out and SAML 2.0 and OAuth 2.0 callbacks. |
| Information | Version, database connection status, license and sign-in providers. No token required. |
| Configuration | Instances, users, network services, schedules, file types and routings. |
| Administration | Operators, groups and permissions, API registration and error and event codes. |
| Supervision and maintenance | Commands to the supervision services, sandbox and keystore files and password, lock and 2FA resets. |
| Reports | Events, operator activities, transfers and audit. |
Each operation states the permission required in the operator’s scope. See Operators and permissions.
Server
The server declared in the specification (https://api.exemplo.com:33070) is illustrative. Before generating a client or testing calls, replace it with the API address of your environment.