Route HTTP
Gli endpoint HTTP gestiscono richieste GraphQL, trasferimenti di file e connessioni dei dispositivi. Consultare ogni endpoint di seguito per il formato della richiesta e i requisiti di autenticazione.
Definizioni di tipo
# 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>Operazioni
POST /graphql
Endpoint GraphQL principale. La modalità token API usa le intestazioni c-id e Authorization: Bearer con JSON; la modalità sessione di accesso usa corpi cifrati.
curl 'https://<device-host>:<https-port>/graphql' \
-H 'c-id: <client-id>' -H ': Bearer <api-token>' \
-H 'Content-Type: application/json' \
--data '{"query":"{ app { deviceName capabilities access } }"}'GET /fs
ID risorsa cifrato: c.CLIENT_ID.PAYLOAD per una sessione o s.SHARE_ID.PAYLOAD per una condivisione attiva. I link di sessione usano app.urlToken, non il token di autenticazione GraphQL. Mantieni privati i link: la revoca della sessione li invalida. DESCRIBE restituisce i metadati e le voci di directory autorizzati. Altre azioni: PREVIEW, DOWNLOAD, PROBE e TRANSCODE. Dimensioni anteprima: SM o LG. Per gli intervalli di byte usa HTTP Range.
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.GET /zip/dir
Scarica una directory autorizzata come ZIP. Accetta un normale ID risorsa /fs di una sessione oppure l’ID di una directory in una condivisione attiva. Le operazioni simultanee possono restituire HTTP 429.
curl 'https://<device-host>:<https-port>/zip/dir?id=<directory-resource-id>' -o directory.zipGET /zip/files
Scarica una selezione di file come ZIP. Richiede un ID ZIP_FILES separato, valido solo per la sessione. Non accetta gli ID /fs né quelli delle condivisioni.
curl 'https://<device-host>:<https-port>/zip/files?id=<selection-archive-id>' -o selection.zipGET /health
Verifica di raggiungibilità senza autenticazione. Restituisce il corpo di testo semplice OK.
curl 'https://<device-host>:<https-port>/health'POST /init
Richiede c-id e accesso remoto abilitato. Un corpo vuoto rileva la configurazione e restituisce authenticated=false. Per verificare una sessione esistente, cifrare l’involucro di richiesta per POST /init con il suo token di autenticazione. La risposta include httpsPort (0 se non è disponibile un listener HTTPS); opaquePublicKey e i campi di prova TLS sono condizionali.
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.POST /guest_graphql
API cifrata limitata alla condivisione con un proprio contratto ospite. c-id identifica una condivisione attiva; un token API non autorizza una richiesta ospite.
# 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 } } }POST /peer_graphql
c-id: ID client del mittente. c-cid: ID del canale di chat. I messaggi di canale includono c-cid e usano la chiave del canale; le richieste dirette tra peer lo omettono e usano la chiave di associazione.
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