PlainApp
API-referentie

Koppelen

Controleer app.capabilities voor functieondersteuning en app.access plus hostrechten voor autorisatie. Voorbeelden gebruiken synthetische waarden; vervang paden, ID’s, invoer en filters vóór aanroepen.

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

QR

QR payload

QR: A toont, B scant. LAN c-id identificeert de afzender; BLE gebruikt een eigen transport. PAIR_CANCEL is optioneel.

Beweeg over een veld of tik erop
1 / 2

Synthetische momentopname op een vast tijdstip; handtekeningen en requestIds komen overeen. 192.0.2.0/24 is gereserveerd voor documentatie. 8443 is de standaard-HTTPS-poort; gebruik in echte aanvragen de ontdekte poort. Deze tijdgebonden aanvragen kunnen niet ongewijzigd worden herhaald.

Bevestig in PlainApp Desktop eerst uitdrukkelijk dat je een nieuw apparaat of een apparaat met een gewijzigde openbare sleutel vertrouwt. Bij deze stap verschijnt geen vergelijkingscode; bij een gewijzigde sleutel zie je een waarschuwing. Gebruik je geen wachtwoord? Vergelijk dan de code die op beide apparaten verschijnt en keur het verzoek daarna op het andere apparaat goed. Bij verificatie met een wachtwoord kan het andere apparaat ook zonder code om goedkeuring vragen.

Typedefinities

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
}

Bewerkingen

subscription

peersChanged

Een wijzigingssignaal ontvangen als peerrecords veranderen.

graphql
subscription peersChanged {
  peersChanged
}
subscription

pairingRequested

Een binnenkomende koppelingsaanvraag ontvangen die op een beslissing wacht.

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

pairingCompleted

Een melding ontvangen dat apparaatkoppeling is voltooid.

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

pairingStarted

Een melding ontvangen dat een koppelingspoging is gestart.

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

pairingFailed

Een melding ontvangen dat een koppelingspoging is mislukt.

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

pairingCanceled

Een melding ontvangen dat een koppelingspoging is geannuleerd.

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

cancelPairing

De huidige koppeling van het opgegeven apparaat annuleren.

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

deletePeer

Apparaat en privéchatgeschiedenis verwijderen; het kanaalrecord behouden als een kanaal het nog gebruikt.

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

pairPeer

Chatkoppeling of beheerlogin starten; true bevestigt ontvangst.

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

respondToPairing

Het openstaande koppelverzoek of de vertrouwensbevestiging van het apparaat accepteren of weigeren.

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

unpairPeer

Lokaal ontkoppelen en beheertoegang verwijderen met behoud van chatgeschiedenis.

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

peerFileUrl

Een download-URL maken met het huidige opgeslagen apparaatadres.

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

peers

Alle opgeslagen apparaten tonen, gekoppeld, ontkoppeld of uitsluitend voor kanalen.

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