Integration Flow
This guide explains the typical integration flow for building applications with the VPT API. Follow these steps to create a complete performance calculation workflow.
Prerequisites
Before you begin, make sure you have:
Create an account at virtualperformancetool.com. You'll need your email and password to authenticate.
Apply for a developer key by contacting VPT support with a detailed explanation of your use case and the application you're building.
An active subscription unlocks access to all airports. Without a subscription, you can still make queries using the demo airports listed below.
If you don't have an active subscription, you can test the API using these demo airports:
To request a developer key, send an email to info@virtualperformancetool.com including:
- Your VPT account email
- Name and description of the application you're building
- Intended use case (personal project, commercial integration, etc.)
Integration Flow Overview
The following diagram illustrates the typical workflow for integrating the VPT API into your application:
login query with your user credentials
and developer key to obtain a JWT token. This token must be
included in all subsequent API requests.
allowedAircrafts query to retrieve the
list of available aircraft profiles. This returns all
aircraft the user has access to based on their subscription
and your developer key permissions. Alternative: If your application is designed for specific aircraft only, you can hardcode the aircraft identifier in your project configuration.
aircraft query to retrieve detailed
information about the selected aircraft profile. This
includes:
- Allowed form elements and input options
- Wind limits and restrictions
- Weight limits (MTOW, MLW, MZFW, etc.)
- Available flap settings and configurations
- List of allowed airports for this profile
- Aircraft weight
- Runway selection
- Flap configuration
- Weather conditions (wind, temperature, QNH)
- Additional options specific to the aircraft type
The form elements and valid ranges are defined in the aircraft information response from Step 3.
- V-speeds (V1, VR, V2, etc.)
- Takeoff/Landing distances
- Performance limitations and warnings
- Climb gradients and obstacle clearance data
- Any applicable cautions or operational notes
Now that you understand the integration flow, explore the Authentication guide for detailed implementation instructions, or dive into the API Reference for endpoint specifications.