Riversoft STCP DirectLink API

Versión 2

Riversoft STCP DirectLink API permite que sus aplicaciones intercambien archivos con Riversoft® STCP DirectLink sin intervención manual: autenticar usuarios, enviar archivos, listar y descargar los archivos disponibles, compartir archivos mediante enlaces seguros y consultar el historial de transferencias.

La API sigue el modelo HTTP/REST, recibe formularios y archivos y responde en JSON (o con el contenido binario del archivo, en las descargas).

Nota

Para el uso de Riversoft STCP DirectLink Portal, la arquitectura y la operación del producto, consulte la documentación de Riversoft STCP DirectLink.

Funcionalidades principales

Funcionalidad	Qué puede hacer
Autenticación	Inicio de sesión con usuario y contraseña (HTTP Basic), MFA, tokens OAuth, intercambio de JWT y Single Sign-On (OAuth 2.0 y 2.1/OpenID Connect y SAML 2.0).
Envío de archivos	Enviar archivos mediante `multipart/form-data` o cuerpo binario, con destinatario y metadatos opcionales.
Recepción de archivos	Listar los archivos disponibles (incluso en el área de respaldo) y descargarlos mediante enlaces firmados.
Enlaces compartidos	Entregar archivos a destinatarios mediante enlaces seguros, con o sin PIN.
Informes	Consultar los registros de transferencia por período, dirección y nombre de archivo.

Información general

Propiedad	Valor
Versión de la API	`v2`
URL base	`https://{host}/directlink/v2`
Protocolo	HTTPS (obligatorio en producción)
Formato de las respuestas	JSON; contenido binario en las descargas
Autenticación	HTTP Basic (inicio de sesión), token Bearer o cookie de sesión, SSO
Especificación	OpenAPI 3.0.3 en portugués, inglés y español

El {host} es la dirección de Riversoft STCP DirectLink de su entorno, proporcionada por el administrador del servicio.

Importante

A partir de Riversoft STCP DirectLink 9.0.1, la API se atiende solo en la versión v2. Si su integración usa la v1, vea Migración de la v1 a la v2.

Por dónde empezar

Inicio rápido

Desde la verificación de disponibilidad hasta el primer envío y la primera descarga.

Autenticación

Elija el método de autenticación de su integración.

Guías

Envío, recepción, uso compartido e informes.

Referencia de la API

Endpoints, parámetros, modelos y códigos de respuesta.

Organización de esta documentación

Sección	Para qué
Conceptos	Comprender la URL base, las credenciales, las sesiones, los enlaces seguros y las reglas de acceso antes de integrar.
Inicio rápido	Realizar las primeras llamadas en pocos minutos.
Seguridad	Buenas prácticas para proteger credenciales, tokens y enlaces.
Autenticación	Paso a paso de cada método de autenticación.
Guías	Tareas completas de transferencia de archivos y consulta.
Solución de problemas	Síntomas comunes y cómo resolverlos.
Referencia	Contrato de cada endpoint, modelos de datos y códigos.

Convenciones de los ejemplos

Los ejemplos usan curl y el host ilustrativo api.ejemplo.com. Sustitúyalo por el host de su entorno.
Los valores entre < y > en los bloques de código son marcadores que se deben sustituir, no valores literales.
Los ejemplos leen contraseñas, PIN y tokens con read -s para que no queden en el historial del shell.
Los ejemplos de respuesta muestran el formato de los campos. Los valores reales dependen del entorno.