OFP Sharing API

Cross-account flight plan sharing. Lets an OFP owner invite another VPT account — by email, by short share-code, or by QR deep-link — to view or co-edit one of their stored flights and its Flight Data.

Overview

Sharing is built on a single table, ofp_shares. Every invite gets two identifiers:

• shareToken — a 48-character URL-safe opaque token. Used inside the QR payload and deep-link URL. Sensitive: only echoed back to the owner.
• shareCode — an 8-character uppercase alphanumeric code (alphabet excludes look-alikes I/O/0/1) for recipients who can’t scan the QR.

A share has a status lifecycle of pending → accepted (or revoked at any time). It may carry an expiresAt after which it can no longer be redeemed even if still pending.

Permission model

Access checks for OFP reads, Flight Data reads, and Flight Data writes all go through the OfpAccessService. It returns the OWNER’s userId for every authorized caller — that’s how shared users read and write the same underlying Flight Data row.

QR code & deep link

The server does not render the QR image — the client does, from the qrPayload string returned by ofpShare and ofpShareList. Both the qrPayload and deepLink use the vpt://share/{shareToken} scheme so the mobile app can register a single deep-link handler that routes straight to ofpShareAccept:

vpt://share/abcDEF-48charsTokenHere
https://www.virtualperformancetool.com/share?t=abcDEF-48charsTokenHere

ofpShare

Owner-only. Creates a new pending invite, returns the token, short share-code and QR payload.

curl -X POST "https://api.virtualperformancetool.com/api" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "ofpShare",
    "data": {
      "ofpId": "12345_4",
      "permission": "edit",
      "sharedWithEmail": "copilot@example.com",
      "expiresInDays": 7
    }
  }'

{
  "success": true,
  "share": {
    "id": 42,
    "ownerUserId": 9576,
    "ofpId": "12345_4",
    "sharedWithUserId": 11203,
    "sharedWithEmail": "copilot@example.com",
    "permission": "edit",
    "status": "pending",
    "shareCode": "K7H2PXQR",
    "createdAt": "2026-05-27 20:14:11",
    "acceptedAt": null,
    "revokedAt": null,
    "expiresAt": "2026-06-03 20:14:11",
    "shareToken": "v9Nq...48charsTotal...wA",
    "shareUrl": "https://www.virtualperformancetool.com/share?t=v9Nq...wA",
    "deepLink": "vpt://share/v9Nq...wA",
    "qrPayload": "vpt://share/v9Nq...wA"
  }
}

ofpShareList

List shares related to the caller. Returns two arrays: issued (shares the caller created — include the shareToken so the owner can re-render the QR) and received (shares targeted at the caller’s userId or email — never include the shareToken).

ofpShareAccept

The recipient redeems an invite using either the shareToken (deep-link / QR path) or the human-typed shareCode. Idempotent: re-accepting an already- accepted share returns success with already: true.

curl -X POST "https://api.virtualperformancetool.com/api" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "ofpShareAccept",
    "data": { "shareCode": "K7H2PXQR" }
  }'

ofpShareRevoke

Either the owner or the current recipient can revoke. The row is kept with status = 'revoked' for audit. Idempotent.

Error codes