Referencia
Referencia de la API
Esta sección es la fuente de consulta del contrato de la API. Para ejemplos paso a paso, vea las Guías.
Convenciones
| Elemento | Valor |
|---|---|
| URL base | https://{host}:{puerto} |
| Credencial en las rutas protegidas | Authorization: Bearer <access_token> |
| Cuerpo de las solicitudes de token | application/x-www-form-urlencoded |
| Cuerpo de las solicitudes de gestión | application/json, indicado exactamente así en Content-Type |
| Cuerpo de las respuestas | application/json |
| Validez del token | 60 minutos de forma predeterminada; ajustable en session_duration (máximo 720 minutos) |
| Fechas en los filtros | Unix timestamp en milisegundos |
Catálogo de endpoints
La Riversoft STCP Gemini API es la misma que usa el Riversoft Console Portal. Todos los endpoints siguientes están disponibles para integración. El contrato completo de cada uno, con parámetros, cuerpos, respuestas y ejemplos, está en la Especificación OpenAPI.
| Grupo | Ruta base | Acceso | Contenido |
|---|---|---|---|
| Autenticación | /oauth, /disconnect | Público / Bearer | Token (/oauth/token, /oauth/v2/token), conclusión del 2FA (/oauth/v2/token/mfa/{challengeID}) y cierre de sesión. Vea Autenticación. |
| Single Sign-On | /auth/api/v1/sso | Público | Inicio de sesión SSO y retornos de SAML 2.0 y OAuth 2.0. |
| Información | /info | Público | version, status, report, license y sso/providers. |
| Configuración | /stcpcore/v2 | Bearer | Instancias, usuarios, servicios de red, agendamientos, tipos de archivo y enrutamientos. Vea Recursos de gestión. |
| Administración | /stcpadmin/v2 | Bearer | Operadores, grupos y permisos, registro de la API (settings), políticas de contraseña y códigos de error y evento. |
| Supervisión | /stcpadminsvc/v2/supervision/stcpmon | Bearer | Comandos a los servicios de supervisión y archivos de sandbox y keystore. |
| Mantenimiento | /stcpadminsvc/v2/supervision/stcpauth | Bearer | Restablecimiento y cambio de contraseña, desbloqueo, hash y 2FA de usuarios y operadores. |
| Informes | /reports/v2 | Bearer | Eventos, actividades de operadores, transferencias y auditoría. Vea Informes. |
En esta sección
Contrato OpenAPI 3.0.3 de todos los endpoints de la Riversoft STCP Gemini API, con visualización interactiva.
Contrato de la emisión del token, del inicio de sesión con 2FA, del Single Sign-On y del logout.
Contrato de los endpoints /reports/v2: system, users, instance, operators, transfers y auditoría.
Endpoints de gestión de instancias, usuarios, servicios de red, agendamientos, tipos de archivo, enrutamientos, operadores, grupos, registro de la API, supervisión y mantenimiento.
Estados HTTP devueltos por la Riversoft STCP Gemini API.