Especificación OpenAPI
El contrato formal de la Riversoft® STCP Gemini API está disponible en formato OpenAPI 3.0.3, compatible con Swagger UI, Postman, Insomnia y los generadores de cliente del ecosistema OpenAPI. Cubre todos los endpoints que usa el Riversoft Console Portal, que también están disponibles para la integración con otros sistemas.
Descarga
| Idioma | Archivo |
|---|---|
| Português | openapi.pt.yaml |
| English | openapi.en.yaml |
| Español | openapi.es.yaml |
Las tres versiones tienen los mismos endpoints, métodos, parámetros, operationId, schemas, reglas de autenticación y ejemplos. El idioma cambia solo los resúmenes, las descripciones y los nombres de los grupos; no cambia el idioma de las respuestas de la API.
Contenido
| Grupo | Endpoints |
|---|---|
| Autenticación y Single Sign-On | Emisión del token, inicio de sesión con 2FA (TOTP), cierre de sesión y retornos de SAML 2.0 y OAuth 2.0. |
| Información | Versión, estado de las conexiones con las bases, licencia y proveedores de inicio de sesión. No exigen token. |
| Configuración | Instancias, usuarios, servicios de red, agendamientos, tipos de archivo y enrutamientos. |
| Administración | Operadores, grupos y permisos, registro de la API y códigos de error y evento. |
| Supervisión y mantenimiento | Comandos a los servicios de supervisión, archivos de sandbox y keystore y restablecimiento de contraseña, bloqueo y 2FA. |
| Informes | Eventos, actividades de operadores, transferencias y auditoría. |
Cada operación indica el permiso exigido en el scope del operador. Vea Operadores y permisos.
Servidor
El servidor declarado en la especificación (https://api.exemplo.com:33070) es ilustrativo. Antes de generar un cliente o probar llamadas, sustitúyalo por la dirección de la API de su entorno.