Справочник API

HTTP-маршруты

Конечные точки HTTP обрабатывают запросы GraphQL, передачу файлов и подключения устройств. Формат запроса и требования аутентификации приведены для каждой точки ниже.

Определения типов

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>

Операции

http

POST /graphql

Основная конечная точка GraphQL. Режим API-токена использует заголовки c-id и Authorization: Bearer с JSON; режим сеанса входа использует зашифрованные тела.

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

Зашифрованный идентификатор ресурса: c.CLIENT_ID.PAYLOAD для сеанса или s.SHARE_ID.PAYLOAD для активной ссылки общего доступа. Ссылки сеанса используют app.urlToken, а не токен аутентификации GraphQL. Не раскрывайте ссылки: отзыв сеанса делает их недействительными. DESCRIBE возвращает разрешённые метаданные и записи каталога. Другие действия: PREVIEW, DOWNLOAD, PROBE и TRANSCODE. Размеры предпросмотра: SM или LG. Диапазоны байтов запрашиваются через 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

Скачивает разрешённый каталог как ZIP. Принимает обычный идентификатор ресурса /fs из сеанса или идентификатор каталога с активным общим доступом. При параллельной архивации может вернуть HTTP 429.

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

GET /zip/files

Скачивает выбранные файлы как ZIP. Требуется отдельный идентификатор ZIP_FILES, привязанный к сеансу. Обычные идентификаторы /fs и общего доступа не принимаются.

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

GET /health

Проверка доступности без аутентификации. Возвращает открытый текст OK в теле.

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

POST /init

Требует c-id и включённого удалённого доступа. Пустое тело получает конфигурацию и возвращает authenticated=false. Для проверки существующего сеанса зашифруйте оболочку запроса для POST /init его токеном аутентификации. Ответ включает httpsPort (0, если слушатель HTTPS недоступен); opaquePublicKey и поля доказательства TLS условны.

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 в области общего доступа со своим гостевым контрактом. c-id определяет активный общий доступ; API-токен не разрешает гостевой запрос.

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 клиента отправителя. c-cid: ID канала чата. Сообщения канала включают c-cid и используют ключ канала; прямые запросы узла опускают его и используют ключ сопряжения.

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