Referencia de la API

Rutas HTTP

Los endpoints HTTP gestionan solicitudes GraphQL, transferencias de archivos y conexiones de dispositivos. Consultar cada endpoint a continuación para ver su formato de solicitud y requisitos de autenticación.

Definiciones de tipos

text
# HTTP
https://<device-host>:<https-port>

POST /graphql
POST /guest_graphql
POST /peer_graphql
GET /fs?id=<resource-id>&action=PREVIEW&size=SM
GET /zip/dir?id=<directory-resource-id>
GET /zip/files?id=<selection-archive-id>
POST /upload
POST /upload_chunk
POST /init
GET /health
POST /nearby
ANY /proxy/:peer/*path

# DLNA
GET/HEAD /dlna/description.xml
GET/HEAD /dlna/av-transport/scpd.xml
GET/HEAD /dlna/rendering-control/scpd.xml
POST /dlna/av-transport/control
POST /dlna/rendering-control/control
SUBSCRIBE/UNSUBSCRIBE /dlna/av-transport/event
SUBSCRIBE/UNSUBSCRIBE /dlna/rendering-control/event
GET/HEAD /dlna/media/:id
NOTIFY /dlna/callback

# WebSocket
wss://<device-host>:<https-port>/graphql?cid=<client-id>
wss://<device-host>:<https-port>/auth?cid=<client-id>
wss://<device-host>:<https-port>/screen?cid=<client-id>
wss://<device-host>:<https-port>/status?cid=<client-id>
wss://<device-host>:<https-port>/image_editor?cid=<client-id>

Operaciones

http

POST /graphql

Endpoint principal de GraphQL. El modo de token de API usa las cabeceras c-id y Authorization: Bearer con JSON; el modo de sesión de inicio de sesión usa cuerpos cifrados.

bash
curl 'https://<device-host>:<https-port>/graphql' \
  -H 'c-id: <client-id>' -H 'Authorization: Bearer <api-token>' \
  -H 'Content-Type: application/json' \
  --data '{"query":"{ app { deviceName capabilities access } }"}'
http

GET /fs

ID de recurso cifrado: c.CLIENT_ID.PAYLOAD para una sesión o s.SHARE_ID.PAYLOAD para un recurso compartido activo. Los enlaces de sesión usan app.urlToken, no el token de autenticación de GraphQL. Mantén los enlaces privados: la revocación de la sesión los invalida. DESCRIBE devuelve los metadatos y las entradas del directorio autorizados. Otras acciones: PREVIEW, DOWNLOAD, PROBE y TRANSCODE. Tamaño de vista previa: SM o LG. Para solicitar intervalos de bytes, usa HTTP Range.

bash
curl 'https://<device-host>:<https-port>/fs?id=<resource-id>&action=PREVIEW&size=SM' -o thumbnail
curl 'https://<device-host>:<https-port>/fs?id=<resource-id>&action=DOWNLOAD' -OJ
curl 'https://<device-host>:<https-port>/fs?id=<resource-id>&action=DESCRIBE'
# describe JSON: {"entry":{"url":"/fs?id=<resource-id>&action=DOWNLOAD","name":"example.txt","isDir":false,"sizeBytes":10},"children":[]}
# action: DESCRIBE | PREVIEW | DOWNLOAD | PROBE | TRANSCODE
# size: SM | LG (PREVIEW only); v: optional cache version
# Byte ranges use the HTTP Range header.
# id: c.<client-id>.<payload> or s.<share-id>.<payload>
# Session links use app.urlToken, not the GraphQL authentication token.
# Keep resource URLs private; revoking the owning session invalidates its links.
http

GET /zip/dir

Descarga un directorio autorizado como ZIP. Acepta un ID de recurso normal de /fs de una sesión o un ID de directorio de un recurso compartido activo. Las operaciones simultáneas pueden devolver HTTP 429.

bash
curl 'https://<device-host>:<https-port>/zip/dir?id=<directory-resource-id>' -o directory.zip
http

GET /zip/files

Descarga una selección de archivos como ZIP. Requiere un ID ZIP_FILES independiente y exclusivo de la sesión. No acepta ID de /fs ni de recursos compartidos.

bash
curl 'https://<device-host>:<https-port>/zip/files?id=<selection-archive-id>' -o selection.zip
http

GET /health

Comprobación de accesibilidad sin autenticación. Devuelve el cuerpo de texto sin formato OK.

bash
curl 'https://<device-host>:<https-port>/health'
http

POST /init

Requiere c-id y acceso remoto activado. Un cuerpo vacío descubre la configuración y devuelve authenticated=false. Para comprobar una sesión existente, cifrar el sobre de solicitud de POST /init con su token de autenticación. La respuesta incluye httpsPort (0 si no hay un servicio de escucha HTTPS disponible); opaquePublicKey y los campos de prueba TLS son condicionales.

bash
curl 'https://<device-host>:<https-port>/init' -X POST -H 'c-id: <client-id>'
# An empty body discovers configuration; it does not prove session authentication.
# To check a session, send an encrypted request envelope bound to POST /init.
http

POST /guest_graphql

API cifrada de ámbito de recurso compartido con su propio contrato de invitado. c-id identifica un recurso compartido activo; un token de API no autoriza una solicitud de invitado.

bash
# Share-scoped encrypted GraphQL, not an API-token request.
# c-id: <share-id>; request bound to POST /guest_graphql.
# Contract: plain-core/schema/guest-api.graphqls
query { sharedInfo { name readOnly requiresPassword entries { name relativePath isDir size } } }
http

POST /peer_graphql

c-id: ID del cliente emisor. c-cid: ID del canal de chat. Los mensajes de canal incluyen c-cid y usan la clave del canal; las solicitudes directas entre pares lo omiten y usan la clave vinculada.

bash
curl 'https://<device-host>:<https-port>/peer_graphql' \
  -H 'c-id: <sender-client-id>' \
  -H 'c-cid: <channel-id>' \
  -H 'Content-Type: application/octet-stream' \
  --data-binary @peer-request.bin \
  --output peer-response.bin