Présentation de l’API

DJI FlightHub 2 OpenAPI est une plateforme ouverte basée sur les spécifications RESTful, conçue pour offrir aux développeurs la possibilité d’interagir avec des plateformes cloud tierces et DJI FlightHub 2.

Voici les principales fonctionnalités d’OpenAPI :

• Conception RESTful : adopte les spécifications RESTful, rendant l’utilisation de l’API plus intuitive et conforme aux standards web. Les développeurs peuvent interagir avec FlightHub 2 en utilisant des méthodes HTTP standard telles que GET, POST, PUT et DELETE.
• Authentification et autorisation : met en œuvre des mécanismes d’authentification et d’autorisation sécurisés pour protéger les ressources de l’API et gérer efficacement les autorisations d’accès.
• Interaction avec FlightHub 2 : offre des fonctionnalités telles que la gestion des organisations et des projets DJI FlightHub 2, la gestion des appareils, la gestion des diffusions en direct, la gestion des itinéraires de vol, la gestion des tâches, la gestion des modèles et la gestion des annotations.
• Support et documentation pour les développeurs : offre une documentation API détaillée, des exemples de code et un support développeur, permettant une intégration rapide et une utilisation efficace des fonctionnalités de la plateforme.

Les développeurs peuvent intégrer rapidement les fonctionnalités principales de FlightHub 2 en appelant OpenAPI, réduisant considérablement les coûts de développement et répondant à divers besoins commerciaux et à des scénarios d’application innovants.

Architecture du produit

Démarrage rapide

Configuration de l’environnement

FlightHub 2 Version publique utilise une API pour interroger l'état du système: Query FlightHub 2 System Status

Reportez-vous au Manuel de déploiement de DJI FlightHub 2 version On-Premises pour effectuer le déploiement: Query FlightHub 2 System Status

Authentification et autorisation

Reportez-vous au tutoriel Authentication and Authorization pour comprendre les principes d’authentification et d’autorisation OpenAPI, obtenir les valeurs de X-User-Token et X-Project-Uuid, et saisir ces deux valeurs dans le champ d’en-tête pour assurer la sécurité d’OpenAPI et permettre le contrôle d’accès à FlightHub 2.

Exemple de code

1. Vérifier le statut système de FlightHub 2

Une fois DJI FlightHub 2 version On-Premises déployée avec succès, appelez la méthode Query FlightHub 2 System Status pour vérifier le statut système.

```http
GET /openapi/v0.1/system_status HTTP/1.1
Host: 127.0.0.1:30812
X-Language: en
X-User-Token: xxxxxxxx

Une valeur de retour de 0 indique que le système FlightHub 2 fonctionne normalement.

```http
{
  "code": 0,
  "message": ""
}

2. Obtenir la liste des projets de l’organisation

Créez une organisation, configurez un projet et liez des appareils dans FlightHub 2. Reportez-vous à la Guide d’utilisateur de DJI FlightHub 2 > Gestion de l’organisation section sur la création d’organisations et de projets dans FlightHub 2, puis appelez la méthode Get the List of Projects under the Organization pour obtenir la liste des projets créés.

```http
GET /openapi/v0.1/project HTTP/1.1
Host: 127.0.0.1:30812
X-Language: en
X-User-Token: xxxxxxxx

La liste des projets créés sera renvoyée.

```http
{
  "code": 0,
  "message": "OK",
  "data": {
    "list": [
      {
        "name": "c2c_test",
        "introduction": "a",
        "uuid": "93df839d-ae74-4f04-842e-2f1f81c89a66",
        "org_uuid": "105ddd05-34ce-46b6-a872-cb32b8c98f64",
        "created_at": 1702498686,
        "updated_at": 1702498686,
        "project_work_center_point": {
          "latitude": 22.906899500237845,
          "longitude": 113.69995967214662
        }
      }
    ]
  }
}

3. Commencer la diffusion en direct

Reportez-vous au Guide d’utilisateur de DJI FlightHub 2 > Gestion des appareils section concernant la liaison des appareils dans FlightHub 2, puis reportez-vous au tutoriel Livestream Management, et appelez la méthode Enable Livestream pour démarrer la diffusion.

```http
POST /openapi/v0.1/live-stream/start HTTP/1.1
Host: 127.0.0.1:30812
X-Project-Uuid: xxxxxxxxxx
X-Language: en
Content-Type: application/json
X-User-Token:  xxxxxxxx
Content-Length: 120
{
    "sn": "7CTDM3Dxxxxxx",
    "camera_index": "165-0-7",
    "video_expire": 7200,
    "video_quality": "adaptive"
}

Le lien de diffusion en direct sera disponible à data.url, où vous pourrez vous rendre pour visualiser la diffusion en direct.

```c
{
  "code": 0,
  "message": "",
  "data": {
    "expire_ts": 1764751629,
    "url": "http://127.0.0.1:30806/rtc/v1/whep/?app=live&stream=7CTDM3Dxxxxxx_165-0-7&token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcm9kdWN0X2lkIjoiNzEzNTE5ZmIxYjRlNDRiYTlkMjdkMDJhOGRlZDk5NGQiLCJjaGFubmVsX25hbWUiOiI3Q1RETTNEMDBCWk5WWl8xNjUtMC03IiwidWlkIjoxDAxMTQsImFjdGlvbiI6InBsYiLCJleHAiOjE3NjQ3NTE2MzAsIm5iZiI6MTczMzIxNTYzMCwiaWF0IjoxNzMzMjE1NjMwfQ._AysitutpprlgYGFy4lDL_gSv4Y3hl_te-yxoFVHZb4",
    "url_type": "srs"
  }
}

Tutoriel d’interface

• Le tutoriel d’interface comprend la liste des fonctionnalités OpenAPI, des tutoriels, la liste des méthodes et des descriptions. Reportez-vous au OpenAPI Interface Tutorial pour plus de détails.