Riversoft STCP Gemini API
Riversoft STCP Gemini API
Versión 3.10.0
La Riversoft STCP Gemini API es la API REST de gestión de Riversoft® STCP Gemini y de Riversoft STCP DirectLink. Es la misma API que usa el Riversoft Console Portal, abierta a integraciones con otros sistemas y proveedores: configurar el entorno, administrar operadores y permisos, supervisar las instancias y consultar informes.
La API sigue el modelo HTTP/REST y recibe y responde en JSON.
Nota
Para enviar y recibir archivos por API, use la Riversoft STCP DirectLink API, dedicada a la transferencia.
Principales recursos
| Recurso | Qué puede hacer |
|---|---|
| Autenticación | Inicio de sesión con 2FA, password grant, LDAP, Single Sign-On (SAML 2.0 y OAuth 2.0) y logout. |
| Configuración | Gestionar instancias, usuarios, servicios de red, agendas, tipos de archivo y enrutamientos. |
| Administración | Gestionar operadores, grupos y permisos, el registro de la API y los códigos de error y evento. |
| Supervisión y mantenimiento | Consultar y comandar las instancias, ejecutar agendas, iniciar conexiones, gestionar archivos de prueba y claves, y restablecer contraseña, 2FA y bloqueo. |
| Informes | Consultar eventos, actividades de operadores, historial de transferencias, estadísticas y auditoría. |
Información general
| Propiedad | Valor |
|---|---|
| Versión del producto | 3.10.0 |
| URL base | https://{host}:{puerto} (puerto predeterminado de ejemplo: 33070) |
| Protocolo | HTTPS (recomendado; habilitado en ssl en el config.json de la API) |
| Formato | JSON; cuerpo con Content-Type: application/json exactamente así |
| Autenticación | Token Bearer: inicio de sesión con 2FA, password grant, LDAP o SSO |
| Especificación | OpenAPI 3.0.3 en portugués, inglés y español |
El {host} y el {puerto} son los configurados en la sección general del config.json de la API. Vea Configuración de Riversoft STCP Gemini.
Por dónde empezar
Obtenga un token y consulte su primer informe.
Elija el método de autenticación de los operadores.
Gestión de recursos y consulta de informes.
Endpoints, parámetros, respuestas y códigos.
Organización de esta documentación
| Sección | Para qué |
|---|---|
| Conceptos | Entender los recursos gestionados, los permisos y la paginación antes de integrar. |
| Inicio rápido | Obtener el primer token y hacer la primera consulta. |
| Seguridad | Buenas prácticas para TLS, credenciales, tokens y auditoría. |
| Autenticación | Paso a paso de cada método de autenticación. |
| Guías | Tareas completas de gestión y de consulta de informes. |
| Solución de problemas | Síntomas comunes y cómo resolverlos. |
| Referencia | Contrato de cada endpoint, estructura del CONFIG_TXT y códigos. |
| Notas de la versión | Novedades, correcciones y cambios incompatibles por versión. |
Convenciones de los ejemplos
- Los ejemplos usan
curly el host ilustrativoapi.ejemplo.com. Sustitúyalo por el host y el puerto de su entorno. - Los valores entre
<y>en los bloques de código son marcadores que deben sustituirse, no valores literales. - Los ejemplos leen contraseñas y códigos con
read -spara que no queden en el historial del shell. - Los ejemplos de respuesta muestran el formato de los campos. Los valores reales dependen del entorno.
- Las fechas de los filtros de los informes son Unix timestamps en milisegundos.