PlainApp
Referência da API

Rotas HTTP

Os endpoints HTTP tratam pedidos GraphQL, transferências de ficheiros e ligações de dispositivos. Consultar cada endpoint abaixo para o formato do pedido e os requisitos de autenticação.

Definições de Tipo

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>

Operações

http

POST /graphql

Endpoint GraphQL principal. O modo de token de API usa os cabeçalhos c-id e Authorization: Bearer com JSON; o modo de sessão de início de sessão usa corpos 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 uma sessão ou s.SHARE_ID.PAYLOAD para uma partilha ativa. As ligações de sessão usam app.urlToken, não o token de autenticação GraphQL. Mantenha as ligações privadas: revogar a sessão invalida-as. DESCRIBE devolve os metadados e as entradas de diretório autorizados. Outras ações: PREVIEW, DOWNLOAD, PROBE e TRANSCODE. Tamanhos da pré-visualização: SM ou LG. Peça intervalos de bytes com 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

Transfere um diretório autorizado como ZIP. Aceita um ID de recurso /fs normal de uma sessão ou o ID de um diretório numa partilha ativa. Operações simultâneas podem devolver HTTP 429.

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

GET /zip/files

Transfere uma seleção de ficheiros como ZIP. Requer um ID ZIP_FILES separado e exclusivo da sessão. Não aceita IDs de /fs ou de partilhas.

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

GET /health

Verificação de acessibilidade sem autenticação. Devolve o corpo de texto simples OK.

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

POST /init

Exige c-id e acesso remoto ativado. Um corpo vazio descobre a configuração e devolve authenticated=false. Para verificar uma sessão existente, cifrar o envelope de pedido para POST /init com o respetivo token de autenticação. A resposta inclui httpsPort (0 quando não há um serviço de escuta HTTPS disponível); opaquePublicKey e os campos de prova TLS são condicionais.

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 limitada à partilha com o seu próprio contrato de convidado. c-id identifica uma partilha ativa; um token de API não autoriza um pedido de convidado.

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 do cliente emissor. c-cid: ID do canal de conversa. As mensagens de canal incluem c-cid e usam a chave do canal; os pedidos diretos entre pares omitem-no e usam a chave de associação.

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