API REST
Riversoft® STCP DirectLink ofrece una API REST para que las aplicaciones envíen y reciban archivos sin intervención manual, con los mismos controles de Riversoft STCP DirectLink Portal: autenticación, áreas de descarga y backup, enlaces seguros y trazabilidad.
La documentación completa de la API (conceptos, autenticación, guías, referencia de endpoints y especificación OpenAPI) está en su propia sección, Riversoft STCP DirectLink API.
Cuándo usar la API
| Escenario | Ejemplo |
|---|---|
| Integración entre sistemas | Un ERP envía facturas y recibe respuestas automáticamente. |
| Distribución a destinatarios externos | Una aplicación envía el archivo y el destinatario recibe un enlace seguro por correo electrónico, SMS o WhatsApp. |
| Portales de servicios | Un portal de terceros autentica al usuario mediante SSO o un token JWT de confianza y lo dirige a Riversoft STCP DirectLink. |
| Auditoría | Un sistema de monitoreo consulta el informe de transferencias. |
Primeros pasos
| Elemento | Valor |
|---|---|
| URL base | https://<dominio>/directlink/v2 |
| Transporte | HTTPS |
| Formato de las respuestas | JSON (contenido binario en las descargas) |
| Versión de la API | v2, indicada en la ruta y en el campo apiver de las respuestas |
| Especificación | OpenAPI 3.0.3, en portugués, inglés y español |
Documentación de la API
| Para | Consulte |
|---|---|
| Hacer las primeras llamadas | Inicio rápido |
| Elegir el método de autenticación (Basic, OAuth 2.0, JWT, SSO, MFA) | Autenticación |
| Enviar, recibir y compartir archivos | Guías |
| Consultar endpoints, modelos de datos y códigos | Referencia de la API |
| Descargar el archivo OpenAPI | Especificación OpenAPI |
Autenticación en la versión 9
Las rutas protegidas de la API (carga, listados, informe y cierre de sesión) exigen un token Bearer. La autenticación Basic se acepta solo en el inicio de sesión. Vea Seguridad › Autenticación en la API.
Colección de Postman
Para simplificar el desarrollo y las pruebas, use la colección de Postman con las llamadas de la API. La colección guarda automáticamente el token obtenido en la variable token, que usan las demás solicitudes.