Introdução à API

O DJI FlightHub 2 OpenAPI é uma plataforma aberta baseada em especificações RESTful, projetada para oferecer aos desenvolvedores a capacidade de interagir com plataformas em nuvem de terceiros e com o DJI FlightHub 2.

Aqui estão alguns recursos principais do OpenAPI:

• Design RESTful: Adota especificações RESTful, tornando o uso da API mais intuitivo e em conformidade com os padrões da web. Os desenvolvedores podem interagir com o FlightHub 2 usando métodos HTTP padrão, como GET, POST, PUT e DELETE.
• Autenticação e autorização: Implementa mecanismos seguros de autenticação e autorização para proteger os recursos da API e gerenciar as permissões de acesso de forma eficaz.
• Interação com o FlightHub 2: Oferece recursos como gerenciamento de organização e projetos do DJI FlightHub 2, gerenciamento de dispositivos, de transmissões ao vivo, de rotas de voo, de tarefas, de modelos e de anotações.
• Suporte e documentação para desenvolvedores: Oferece documentação detalhada da API, exemplos de código e suporte para desenvolvedores, permitindo integração rápida e uso eficaz dos recursos da plataforma.

Os desenvolvedores podem integrar rapidamente os recursos centrais do FlightHub 2 chamando o OpenAPI, reduzindo significativamente os custos de desenvolvimento e atendendo a diversas necessidades de negócios e cenários de aplicação inovadores.

Arquitetura do produto

Ativação rápida

Configuração do ambiente

Consulte o manual de implantação da versão local do DJI FlightHub 2 para implantar a versão local do FlightHub 2.

Autenticação e autorização

Consulte o tutorial de autenticação e autorização para entender os princípios de autenticação e autorização do OpenAPI, obter os valores de X-User-Token e X-Project-Uuid e inserir esses dois valores no campo de cabeçalho para garantir a segurança do OpenAPI e realizar o controle de acesso ao FlightHub 2.

Código de exemplo

1. Consultar o status do sistema do FlightHub 2

A versão pública do FlightHub 2 usa API para consultar o status do sistema: Consultar Status do Sistema do FlightHub 2

Após a implantação bem-sucedida da versão local do FlightHub 2, invoque o método para verificar o status do sistema: Consultar Status do Sistema do FlightHub 2

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

Um valor de retorno igual a 0 indica que o sistema FlightHub 2 está operando normalmente.

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

2. Obter a lista de projetos da organização

Crie uma organização, configure um projeto e vincule dispositivos no FlightHub 2. Consulte a manual do usuário do DJI FlightHub 2 > Gerenciamento da organização e saiba sobre como criar organizações e projetos no FlightHub 2 e, em seguida, invoque o método Obter a lista de projetos da organização para obter a lista de projetos criados.

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

Será exibida a lista de projetos criados.

```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. Começar transmissão ao vivo

Consulte o manual do usuário do DJI FlightHub 2 > Gerenciamento do dispositivo para saber sobre como vincular dispositivos no FlightHub 2. Depois, consulte o tutorial de Gerenciamento de transmissão ao vivo e invoque o método Habilitar transmissão ao vivo para começar 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"
}

O link da transmissão ao vivo estará disponível em data.url, onde você pode acessá-lo para assistir à transmissão.

```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 da interface

• O tutorial da interface inclui a lista de recursos do OpenAPI, tutoriais, lista de métodos e descrições. Consulte o tutorial de interface do OpenAPI para mais detalhes.