Référence de l'API

Appairage

Vérifier app.capabilities pour la prise en charge des fonctionnalités et app.access ainsi que les permissions de l’hôte pour les autorisations. Les exemples utilisent des valeurs synthétiques ; remplacer les chemins, ID, entrées et filtres avant tout appel.

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

QR

QR payload

QR : A affiche, B lit. En LAN, c-id identifie l’émetteur ; BLE utilise son propre transport. PAIR_CANCEL est facultatif.

Survoler ou toucher un champ
1 / 2

Instantané synthétique à un instant fixe ; signatures et requestIds correspondent. 192.0.2.0/24 est réservé à la documentation. 8443 est le port HTTPS par défaut ; utiliser le port découvert dans les requêtes réelles. Ces requêtes limitées dans le temps ne peuvent pas être rejouées telles quelles.

Dans PlainApp Desktop, confirmez d’abord explicitement que vous faites confiance à un nouvel appareil ou à un appareil dont la clé publique a changé. Aucun code de comparaison ne s’affiche à cette étape ; un avertissement signale tout changement de clé. Sans mot de passe, comparez ensuite le code affiché sur les deux appareils avant d’approuver la demande sur l’autre appareil. Si vous avez utilisé un mot de passe, l’autre appareil peut demander une approbation sans afficher de code.

Définitions de types

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
}

Opérations

subscription

peersChanged

Recevoir un signal lorsque les enregistrements de pairs changent.

graphql
subscription peersChanged {
  peersChanged
}
subscription

pairingRequested

Recevoir une demande d’association entrante en attente de décision.

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

pairingCompleted

Recevoir une notification de fin d’association des appareils.

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

pairingStarted

Recevoir une notification de début d’une tentative d’association.

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

pairingFailed

Recevoir une notification d’échec d’une tentative d’association.

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

pairingCanceled

Recevoir une notification d’annulation d’une tentative d’association.

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

cancelPairing

Annuler le jumelage en cours de l’appareil indiqué.

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

deletePeer

Supprimer l’appareil et son historique de discussion individuelle ; conserver son entrée si un canal le référence encore.

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

pairPeer

Démarrer le jumelage de discussion ou la connexion de gestion ; true confirme la prise en compte.

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

respondToPairing

Accepter ou refuser la demande de jumelage ou la confirmation de confiance en attente de cet appareil.

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

unpairPeer

Dissocier localement et retirer l’accès de gestion tout en conservant les discussions.

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

peerFileUrl

Créer une URL de téléchargement avec l’adresse actuellement enregistrée de l’appareil.

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

peers

Lister tous les appareils enregistrés, jumelés, dissociés ou référencés uniquement par un canal.

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