Saltar al contenido

Inicio rápido

Esta guía lo lleva desde la primera llamada hasta el envío y la descarga de un archivo, con un token OAuth obtenido con usuario y contraseña.

Importante

Use un usuario de prueba. No reutilice credenciales de producción en entornos de prueba.

Requisitos previos:

  • host de Riversoft® STCP DirectLink de su entorno, proporcionado por el administrador del servicio;
  • usuario y contraseña con permiso de envío y descarga;
  • curl instalado.

Defina la URL base

export API_BASE='https://api.ejemplo.com/directlink/v2'

Sustituya api.ejemplo.com por el host de su entorno.

Verifique la disponibilidad

curl -i "$API_BASE/healthcheck"

La respuesta 200 indica que la API está accesible:

{
  "status": "ok",
  "service": "STCPDirectLink",
  "timestamp": "2026-10-16T19:29:23Z",
  "uptime_seconds": 86400
}

Obtenga un token de acceso

read -r -p 'Usuario: ' API_USER
read -r -s -p 'Contraseña: ' API_PASSWORD; printf '\n'

curl -s \
  --data-urlencode 'grant_type=password' \
  --data-urlencode "username=$API_USER" \
  --data-urlencode "password=$API_PASSWORD" \
  "$API_BASE/oauth2/token"

Copie el valor de access_token de la respuesta en una variable:

export ACCESS_TOKEN='<access_token recibido>'

Envíe un archivo

curl -i \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -F 'file=@./documento.pdf' \
  "$API_BASE/upload"

La respuesta 200 incluye los datos de la transferencia, como id, destination y length.

Liste los archivos disponibles

curl -s \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  "$API_BASE/download/list"

Cada elemento de files tiene un linkURL, el enlace firmado para descargar ese archivo.

Descargue un archivo

export FILE_URL='<linkURL del archivo elegido>'
curl -L --fail --output ./documento-descargado.pdf "$FILE_URL"

Finalice la sesión

curl -i -X POST \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  "$API_BASE/auth/logout"

Resultado esperado: el archivo enviado aparece en el destino configurado para el usuario y el archivo elegido en el listado se guarda en ./documento-descargado.pdf.

Nota

Las operaciones dependen de las reglas configuradas para el usuario. Si algún paso devuelve 403, consulte Reglas de acceso y Solución de problemas.

Próximos pasos