Referencia
Referencia de la API
Esta sección es la fuente de consulta del contrato de la API. Para ejemplos paso a paso, consulte las Guías y Autenticación.
Convenciones
| Elemento | Valor |
|---|---|
| URL base | https://{host}/directlink/v2 |
| Credencial en las rutas protegidas | Authorization: Bearer <access_token> o cookie __Host-dirl_session (prevalece la cabecera) |
| Cuerpo de las solicitudes | application/x-www-form-urlencoded, multipart/form-data o application/octet-stream |
| Cuerpo de las respuestas | application/json; contenido binario en las descargas; XML en los metadatos SAML |
Tipos de acceso
| Acceso | Significado |
|---|---|
| Público | No requiere credencial. |
| HTTP Basic | Usuario y contraseña en la cabecera Authorization: Basic. |
| Sesión | Token Bearer o cookie de sesión. |
| Enlace seguro | URL firmada emitida por la API; los parámetros del enlace autorizan la operación. |
| Proveedor | Llamada que realiza el proveedor de identidad durante el flujo SSO. |
Catálogo de endpoints
| Método | Ruta | Acceso | Descripción |
|---|---|---|---|
GET | /healthcheck | Público | Verifica la disponibilidad. |
GET, POST | /auth/login | HTTP Basic | Inicia la sesión local; puede requerir MFA. |
GET, POST | /auth/mfa | Enlace seguro | Valida el segundo factor. |
GET, POST | /auth/mfa/register | Enlace seguro | Confirma el registro del autenticador TOTP. |
POST | /auth/token | Público (formulario OAuth) | Emite un token mediante password grant o token exchange. |
POST | /oauth2/token | Público (formulario OAuth) | Equivalente a /auth/token. |
GET | /auth/firstaccess | Público | Inicia el primer acceso. |
GET | /auth/forget | Público | Inicia la recuperación de contraseña. |
POST | /auth/change | Enlace seguro | Completa el primer acceso o el cambio de contraseña. |
GET, POST | /auth/logout | Sesión | Finaliza la sesión. |
GET | /sso/login | Público | Inicia el inicio de sesión federado. |
GET | /sso/logout | Sesión | Inicia el cierre de sesión federado. |
GET, POST | /sso/oauth2/cb | Proveedor | Callback OAuth 2.0 y 2.1/OpenID Connect. |
GET, POST | /sso/oauth2/logout/cb | Proveedor | Callback de cierre de sesión OAuth 2.0. |
POST | /sso/saml2/acs | Proveedor | Recibe la aserción SAML 2.0. |
GET, POST | /sso/saml2/slo | Proveedor | Recibe el mensaje de cierre de sesión SAML 2.0. |
GET | /sso/saml2/metadata | Público | Metadatos SAML 2.0 del proveedor. |
GET | /sso/saml2/metadata/{provider} | Público | Metadatos SAML 2.0 del proveedor. |
POST | /upload | Sesión | Envía un archivo. |
GET | /download/list | Sesión | Lista los archivos disponibles. |
GET | /download/list/backup | Sesión | Lista los archivos del área de respaldo. |
GET | /download/file | Enlace seguro y token | Descarga un archivo listado. |
GET | /download/file/backup | Enlace seguro y token | Descarga un archivo del área de respaldo. |
GET | /download | Enlace seguro | Entrega un archivo compartido. |
GET | /download/pin | Enlace seguro | Envía el PIN y devuelve el enlace de descarga. |
GET | /report | Sesión | Consulta los registros de transferencia. |
Nota
Cuando Cloudflare Turnstile está habilitado en el entorno, /auth/login, /auth/firstaccess y /auth/forget exigen el header CF-Turnstile-Response. Vea Cloudflare Turnstile.
En esta sección
Contrato OpenAPI 3.0.3 de la API en portugués, inglés y español, con visualización interactiva.
Endpoint de verificación de disponibilidad de la API.
Endpoints de inicio de sesión, MFA, emisión de token, primer acceso, contraseña y cierre de sesión.
Endpoints de inicio y cierre de sesión, callbacks y metadatos para OAuth 2.0 y 2.1/OpenID Connect y SAML 2.0.
Endpoints de envío, listado y descarga de archivos y enlaces compartidos.
Endpoint de consulta de los registros de transferencia.
Estructura de los objetos JSON devueltos por la API.
Estados HTTP, errores de emisión de token y eventos de sesión y transferencia.