Referencia de la API

Emparejamiento

Consultar app.capabilities para comprobar la compatibilidad de funciones y app.access junto con los permisos del anfitrión para la autorización. Los ejemplos usan valores sintéticos; sustituir las rutas, ID, entradas y filtros antes de llamar.

Device A
plainapp://pair?request=<URL-encoded JSON>
Device B

QR

QR payload

QR: A lo muestra y B lo escanea. En LAN, c-id identifica al emisor; BLE usa su propio transporte. PAIR_CANCEL es opcional.

Pasar el cursor o tocar un campo
1 / 2

Instantánea sintética en un momento fijo; las firmas y requestIds coinciden. 192.0.2.0/24 está reservado para documentación. 8443 es el puerto HTTPS predeterminado; usar el puerto detectado en solicitudes reales. Estas solicitudes de duración limitada no pueden repetirse tal cual.

Para gestionar un dispositivo nuevo o cuya clave pública haya cambiado, confirma primero que confías en él desde PlainApp Desktop. En este paso no se muestra ningún código y se avisa si la clave ha cambiado. Si no has usado contraseña, compara el mismo código en ambos dispositivos antes de aprobar la solicitud en el otro dispositivo. Si has usado contraseña, el otro dispositivo puede pedir aprobación sin mostrar un código.

Definiciones de tipos

graphql
type Subscription {
  peersChanged: Boolean!
  pairingRequested: PairingRequestNotice!
  pairingCompleted: PairingCompletedNotice!
  pairingStarted: PairingProgressNotice!
  pairingFailed: PairingProgressNotice!
  pairingCanceled: PairingProgressNotice!
}

type Mutation {
  cancelPairing(peerId: ID!): Boolean!
  deletePeer(peerId: ID!): Boolean!
  pairPeer(peerId: ID!, input: PairPeerInput!): Boolean!
  respondToPairing(peerId: ID!, accepted: Boolean!): Boolean!
  unpairPeer(peerId: ID!): Boolean!
}

type Query {
  peerFileUrl(peerId: ID!, fileId: String!): String!
  peers: [Peer!]!
}

enum DeviceType {
	COMPUTER
	PHONE
	TABLET
	TV
	NAS
	OTHER
}

scalar Instant

input PairPeerInput {
	mode: PairingMode!
	password: String
}

type PairingCompletedNotice {
	deviceId: ID!
	deviceName: String!
	ip: String!
	port: Int
	deviceType: DeviceType
	requestId: String
}

enum PairingErrorCode {
	TIMEOUT
	REJECTED
	PASSWORD_REQUIRED
	INVALID_PASSWORD
	PEER_IDENTITY_CHANGED
	TOO_MANY_LOGIN_ATTEMPTS
	INTERNAL_ERROR
}

enum PairingMode {
	CHAT
	MANAGE
}

type PairingProgressNotice {
	verificationCode: String
	deviceId: ID!
	deviceName: String!
	error: PairingErrorCode
}

type PairingRequestNotice {
	fromIp: String!
	fromId: ID!
	fromName: String!
	deviceType: DeviceType!
	verificationCode: String!
	identityChanged: Boolean!
}

type Peer {
	id: ID!
	name: String!
	ip: String!
	status: PeerStatus!
	port: Int
	deviceType: DeviceType!
	createdAt: Instant!
	updatedAt: Instant!
	online: Boolean!
	managed: Boolean!
	key: String!
	publicKey: String!
	token: String!
}

enum PeerStatus {
	PAIRED
	UNPAIRED
	CHANNEL
}

Operaciones

subscription

peersChanged

Recibir una señal cuando cambien los registros de pares.

graphql
subscription peersChanged {
  peersChanged
}
subscription

pairingRequested

Recibir una solicitud entrante de vinculación pendiente de decisión.

graphql
subscription pairingRequested {
  pairingRequested { fromIp fromId fromName deviceType verificationCode identityChanged }
}
subscription

pairingCompleted

Recibir una notificación de finalización de la vinculación de dispositivos.

graphql
subscription pairingCompleted {
  pairingCompleted { deviceId deviceName ip port deviceType requestId }
}
subscription

pairingStarted

Recibir una notificación del inicio de un intento de vinculación.

graphql
subscription pairingStarted {
  pairingStarted { verificationCode deviceId deviceName error }
}
subscription

pairingFailed

Recibir una notificación de fallo de un intento de vinculación.

graphql
subscription pairingFailed {
  pairingFailed { verificationCode deviceId deviceName error }
}
subscription

pairingCanceled

Recibir una notificación de cancelación de un intento de vinculación.

graphql
subscription pairingCanceled {
  pairingCanceled { verificationCode deviceId deviceName error }
}
mutation

cancelPairing

Cancelar el emparejamiento actual del dispositivo indicado.

graphql
mutation cancelPairing($peerId: ID!) {
  cancelPairing(peerId: $peerId)
}
mutation

deletePeer

Eliminar el dispositivo y su historial de chat individual; conservar el registro si un canal aún lo referencia.

graphql
mutation deletePeer($peerId: ID!) {
  deletePeer(peerId: $peerId)
}
mutation

pairPeer

Iniciar el emparejamiento de chat o el acceso de administración; true confirma la recepción.

graphql
mutation pairPeer($peerId: ID!, $input: PairPeerInput!) {
  pairPeer(peerId: $peerId, input: $input)
}
mutation

respondToPairing

Aceptar o rechazar la solicitud de emparejamiento o confirmación de confianza pendiente del dispositivo.

graphql
mutation respondToPairing($peerId: ID!, $accepted: Boolean!) {
  respondToPairing(peerId: $peerId, accepted: $accepted)
}
mutation

unpairPeer

Desemparejar localmente y retirar el acceso de administración, conservando el historial de chat.

graphql
mutation unpairPeer($peerId: ID!) {
  unpairPeer(peerId: $peerId)
}
query

peerFileUrl

Crear una URL de descarga con la dirección guardada actual del dispositivo.

graphql
query peerFileUrl($peerId: ID!, $fileId: String!) {
  peerFileUrl(peerId: $peerId, fileId: $fileId)
}
query

peers

Listar todos los dispositivos guardados, emparejados, desemparejados o referenciados solo por canales.

graphql
query peers {
  peers { id name ip status port deviceType createdAt updatedAt }
}