Introducción a la API

DJI FlightHub 2 OpenAPI es una plataforma abierta basada en especificaciones RESTful, diseñada para proporcionar a los desarrolladores la capacidad de interactuar con plataformas de nube de terceros y DJI FlightHub 2.

Estas son algunas características clave de OpenAPI:

• Diseño RESTful: Adopta especificaciones RESTful, lo que hace que el uso de la API sea más intuitivo y conforme a los estándares web. Los desarrolladores pueden interactuar con FlightHub 2 utilizando métodos HTTP estándar como GET, POST, PUT y DELETE.
• Autenticación y autorización: Implementa mecanismos seguros de autenticación y autorización para proteger los recursos de la API y gestionar los permisos de acceso de manera efectiva.
• Interacción de FlightHub 2: Ofrece funciones como la gestión de organización y proyectos de DJI FlightHub 2, gestión de dispositivos, gestión de transmisión en directo, gestión de rutas de vuelo, gestión de tareas, gestión de modelos y gestión de anotaciones.
• Soporte y documentación para desarrolladores: Ofrece documentación detallada de API, ejemplos de código y soporte para desarrolladores, lo que permite una integración rápida y una utilización efectiva de las características de la plataforma.

Los desarrolladores pueden integrar rápidamente las características principales de FlightHub 2 llamando a OpenAPI, lo que reduce significativamente los costes de desarrollo y satisface así diversas necesidades empresariales y situaciones de aplicación innovadoras.

Arquitectura del producto

Inicio rápido

Configuración del entorno

Consulte el Manual de despliegue de la versión local de DJI FlightHub 2 para desplegar la versión local de FlightHub 2.

Autenticación y autorización

Consulte el tutorial de Authentication and Authorizatio para entender los principios de autenticación y autorización de OpenAPI, obtener los valores de X-User-Token y X-Project-Uuid y acceder a estos dos valores en el campo de encabezado para garantizar la seguridad de OpenAPI y lograr el control de acceso a FlightHub 2.

Código de ejemplo

1. Consultar el estado del sistema de FlightHub 2

La nube Versión pública de FlightHub 2 utiliza una interfaz API para consultar el estado del sistema: Query FlightHub 2 System Status

Después de que la versión local de FlightHub 2 se despliegue con éxito, para verificar el estado del sistema:Query FlightHub 2 System Status

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

Un valor de retorno de 0 indica que el sistema FlightHub 2 está operando normalmente.

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

2. Obtener la lista de proyectos de la organización

Crear una organización, configurar un proyecto y vincular dispositivos en FlightHub 2. Consulte la sección Manual de usuario de DJI FlightHub 2 > Gestión de dispositivos sobre cómo crear organizaciones y proyectos en FlightHub 2. Luego llame al método Get the List of Projects under the Organizationpara obtener la lista de proyectos creados.

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

Se devolverá la lista de proyectos creados.

```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. Iniciar transmisión en directo

Consulte la secciónManual de usuario de DJI FlightHub 2 > Gestión de dispositivos sobre la vinculación de dispositivos en FlightHub 2. Luego consulte el tutorial de Livestream Management y llame al método Enable Livestream para comenzar a transmitir.

```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"
}

El enlace de la transmisión en directo estará disponible en data.url, a donde podrá acceder para ver la transmisión en directo.

```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"
  }
}

Tutorial de la interfaz

• El tutorial de interfaz incluye la lista de características de OpenAPI, tutoriales, lista de métodos y descripciones. Consulte el OpenAPI Interface Tutorial para obtener más información.