1. Usage Guide
FlightHub 2 OpenAPI V2.0 (Public Cloud)
  • FlightHub 2 OpenAPI V2.0
    • Usage Guide
      • Authentication Tutorial
      • Error Code
    • Common
      • Common Tutorial
      • System Health & Access
        • Query FlightHub 2 System Status
        • Query System Health Status
        • Get Project Storage Upload STS Credentials
      • Security
        • SN Decrypt Echo
    • Organization & Project
      • Organization & Project Tutorial
      • Members & Permissions Management
        • Project Members
          • Add Members to Project
          • Get Project User List
          • Get Project Independent Member List
        • Organization Members
          • Get Organization User List
          • Get Current User's Organization Role
        • Roles & Permissions
          • Get Role List
          • Get Permission List
          • Get Role Permissions
      • Project Management
        • Project Collaboration
          • Get Project Quick-Join Information
        • Project Configuration
          • Get Auto Recording Config
        • Project Basic Info
          • Get Project List Under Organization
      • Organization Management
        • Organization Basic Info
          • Get Organization List
          • Get Organization Details
    • Device Management
      • Device Management Tutorial
      • Device List Management
        • Device List (Organization Scope)
          • Get Device List Under Organization
        • Device List (Project Scope)
          • Get Project Device Details
          • Get Project Device List
          • Update Device's Bound Project
          • Get Project Device History Topology
      • Device Configuration
        • Calibration & Positioning
          • Custom Network RTK Calibration
        • Pairing Management
          • Query Relay Pairing Result
          • Make Device Enter Relay Pairing Mode
      • Get HMS Information
      • Acquire Control Permission
      • Release Control Permission
      • Live View Quality Settings
      • Get Thing Model
    • Real-time Control
      • Real-time Control Tutorial
      • Control Permission Management
        • Device Control Permission
          • Query Device Control Status (Organization Device )
          • Query Device Control Status (Project Device)
        • Cloud Control Permission
          • Get Cloud Control Status
      • Payload Control
        • Camera Control
          • Aircraft Lens Switch
          • Dock Camera Switch
      • Flight Control Commands
        • General Real-time Commands
          • Query Device Command Execution
          • Send Real-time Control Command
      • Takeoff/Landing Coordination
        • Query Takeoff/Landing Coordination Area (TCA) Real-time Status
    • Livestream
      • Livestream Tutorial
      • Query Recording Tasks
        • Get Recording Tasks for Project Device
        • Get Recording Tasks for Organization Device
      • Livestream Sharing & Forwarding
        • Bypass Streaming
          • Create Stream Converter
          • Get Stream Converter List
          • Delete Stream Converter
          • Enable/Disable Stream Converter
        • Livestream Sharing
          • Get Device Livestream Share Details
          • Get Device Livestream Share List
      • Livestream Push
        • Start Livestream
    • Flight Task
      • Flight Task Tutorial
      • AI Flight Alerts
        • Query Flight Task Alert Records
        • Query AI Alert Records
      • Task Creation
        • Check Whether Flight Task Meets Dispatch Conditions
        • Create Flight Task
        • Resumable Immediate Task
      • Task Query
        • Get Recent Flight Task List
        • Get Default Task Name on Creation
        • Get Flight Task List
        • Get Flight Task Track Information
        • Get Wayline Task Details
        • Get Flight Task Information
        • Get Flight Task List
        • Get Media Resources from Flight Task
      • Flight Record
        • Get Export History
        • Get Single Flight Record Download Link
        • Get Wayline Task Operation Log
      • Task Update
        • Update Flight Task Status
    • Wayline
      • Wayline Tutorial
      • Wayline Management
        • Wayline Query
          • Get Wayline Details
          • Get Wayline List Under Project
        • Wayline Upload
          • Wayline Upload Completion Notification
    • Map
      • Map Tutorial
      • Map Annotation
        • Annotation Creation
          • Create Map Annotation
        • Annotation Update
          • Annotation Update
        • Annotation Deletion
          • Annotation Deletion
      • Airspace Safety
        • Terrain Obstacles
          • Get Offline Map URL
          • Get Offline Map Details
        • Custom Flight Area
          • Get Flight Area List (Workspace Scope)
          • Get Flight Area File URL
          • Get Flight Area List (Project Scope)
      • Airspace Warning
        • Airspace Warning
    • Model Reconstruction
      • Model Reconstruction Tutorial
      • Get Project Model List
      • Model Reconstruction
      • Get Model Details
      • Get Model File Download Link
    • Open Modeling
      • Open Modeling Tutorial
      • Start Reconstruction Task
      • Get Model Details
      • Delete Model
      • Stop Reconstruction Task
      • Get Resource Details
      • Delete Resource
      • Get Upload Credentials
      • Upload Callback
      • Get In-Progress Reconstruction Model Details
  1. Usage Guide

Authentication Tutorial

Overview#

The authentication feature is mainly used to ensure API security and implement access control to FlightHub 2.
Authentication is the process of verifying user identity. The OpenAPI performs authentication by passing X-User-Token in the Header parameter of an HTTPS request.
Authorization refers to determining whether an authenticated user has permission to access specific resources. FlightHub 2 performs authorization against the provided X-User-Token and X-Project-Uuid. Please ensure that the user corresponding to X-User-Token has the required permissions for the project so it can be accessed normally.
Note: X-User-Token is a JWT ticket. You can use a JWT Decoder (https://fusionauth.io/dev-tools/jwt-decoder) to parse out the user information corresponding to the token. When authentication fails, please check on FlightHub 2 whether the user has permission for the project being accessed.
JWT ticket example:
image.png

Interface Usage Flow#

Refer to the sequence diagram below to obtain the user Token and project UUID offline. You must pass X-User-Token and X-Project-Uuid in the Header parameter of the OpenAPI interface to communicate with FlightHub 2.
The current FlightHub 2 X-User-Token is the cloud-interconnect organization key. The path to obtain the organization key is: FlightHub 2 -> My Organization -> Organization Settings -> Cloud Interconnect -> Organization Key.
Clipboard_Screenshot_1779849554.png
X-Project-Uuid can be obtained from data.list.uuid in the "Get Project List Under Organization" interface.
Take "Add Members to Project" as an example:
Modified at 2026-05-27 02:40:01
Next
Error Code
Built with