全新司空 2 OpenAPI V1.0(openapi-translation)
  1. Authentication and Authorization
全新司空 2 OpenAPI V1.0(openapi-translation)
  • Root Directory
    • Authentication and Authorization
      • Authentication Authorization Tutorial
    • System Services
      • FlightHub 2 Public Cloud Access Point Information
      • Query FlightHub 2 System Status
    • Organization Projects
      • Organization Project Tutorial
      • Get the List of Projects Under the Organization
      • Get the List of Devices Under the Organization
      • Get the List of Devices Under the Project
      • Obtain the storage upload credentials for the project
      • Add Members to the Project
    • Livestream Management
      • Live streaming management tutorial
      • Push Livestream
        • Enable Livestream
      • Stream forwarding (only supports private cloud)
        • Stream Forwarding Error Code
        • Create Stream Forwarder
        • Enable/Disable Stream Forwarder
    • Annotation Management
      • Annotation management tutorial
      • Create Map Annotations
    • Task Management
      • Task management tutorial
      • Create Flight Tasks
      • Update Flight Task Status
      • Get the Flight Task List
      • Get Media Files Generated by the Flight Task
      • Get Flight Trajectory Information
    • Device Management
      • Device management tutorial
      • Get Device Properties
      • Get HMS Information
      • Switch Dock Cameras
      • Switch Aircraft Cameras
      • Custom Network RTK Calibration
      • Specify device to enter relay frequency pairing mode (only supports private cloud and relay)
      • Query relay frequency pairing result (only supports private cloud and relay)
    • Route Management
      • Route management tutorial
      • Flight Route Upload Completion Notification
      • Get the List of Flight Routes Under the Project
      • Get Flight Route Details
    • Model Management
      • Model management tutorial
      • Model reconstruction coordinate system
      • Get the List of Models Under the Project
      • Mapping
      • Get the Model Details
      • Get Model File Download URL
    • Open modeling
      • Open modeling tutorial
      • Model Reconstruction Error Code
      • Algorithm parameter introduction
      • Get upload credential
      • Upload callback
      • Get resource details
      • Delete resource
      • Start reconstruction task
      • Stop reconstruction task
      • Get the Model Details
      • Delete Models
  • Get the Stream Transcoder List
    GET
  • Send Real-Time Control Command
    POST
  • Delete Stream Forwarder
    DELETE
  • Acquire Control
    POST
  • Release Control
    DELETE
  • Video Transmission Quality Settings
    PUT
  • Get the Flight Task Information
    GET
  1. Authentication and Authorization

Authentication Authorization Tutorial

Feature Introduction#

The authentication and authorization feature is primarily used to ensure the security of the API and to implement access control for FlightHub 2.
Authentication is the process of verifying a user's identity. OpenAPI authenticates by passing the X-User-Token in the Header parameters of an HTTPS request.
Authorization refers to the process of determining whether a user has permission to access specific resources after authentication is successful. FlightHub 2 will authenticate based on the provided X-User-Token and X-Project-Uuid. Please ensure that the user corresponding to the X-User-Token has the necessary project permissions to access the project.
Note: X-User-Token is a JWT token. You can use JWT Decoder (https://fusionauth.io/dev-tools/jwt-decoder) to decode the user information corresponding to this token. When authorization fails, check on Sikong 2 whether the user has access to the project.
Example of a JWT token:
image.png

Interface Usage#

Please refer to the following sequence diagram to obtain the user token and project UUID offline. You need to pass X-User-Token and X-Project-Uuid in the Header parameters of the OpenAPI interface to communicate with FlightHub 2.
The current X-User-Token for FlightHub 2 is the organization key for FlightHub Sync. The path to obtain the organization key is as follows: FlightHub 2 > My Organization > Organization Settings > FlightHub Sync > Organization Key.
image.png
X-Project-Uuid can be obtained from the data.list.uuid in the interface for achieving the list of projects in the organization.
Take adding member to a project as an example:
修改于 2025-04-29 08:41:58
下一页
FlightHub 2 Public Cloud Access Point Information
Built with