APIインターフェースをどのように使用しますか？

GISBoxはAPIインターフェースの使用をサポートしています。GISBox ソフトウェアを開いた後、左側のツールバーから「API」セクションを選択し、右上隅の「キー追加」ボタンをクリックして API インターフェースを追加できます。「キー」と「セキュリティキー」は、Auth パラメータとして、ユーザーの身分証明またはアプリケーションの合法性を確認するために使用されます。関連するチュートリアルをクリックして確認してください →Auth パラメータ。

「キー名」とは、特定の情報を伝えるために使用されるキー名のことを指します。これは通常、リクエストパラメータ、HTTP ヘッダー、またはレスポンスデータに含まれています。新しいキーを追加する際には、対応する「キー名」を記入する必要があります。以下の図のように記載してください。

右側の操作で「キー名」を変更することができます。

【温馨提示】GSIBox 的 API 功能需要“集团版”套餐才能使用，如需使用，请扫码联系 GISBox 官方微信客服做进一步沟通。

1. 基本 URL

すべての API リクエストの基礎 URL は以下の通りです：

1	メインアカウントSaaSアクセスアドレス + /api/v1

“主账号 SaaS 访问地址”可以在 GISBox 软件的“设置”→“域名端口”中进行查看，如下图所示： 「メインアカウント SaaS アクセスアドレス」は GISBox ソフトウェアの「設定」→「ドメインポート」で確認できます。

例として、メインアカウント SaaS アクセスアドレスが以下のような場合：

1	http://192.168.31.122:42225

API リクエストの基本 URL は次のようになります：

1	http://192.168.31.122:42225/api/v1

2. Auth パラメータ

API リクエストのセキュリティを確保するため、すべてのリクエストには以下のパラメータを含める必要があります。「キー」と「セキュリティキー（secret）」を使用した検証を行います：

名称	タイプ	必須	説明
key	string	はい	発行されたキー
timestamp	string	はい	現在のタイムスタンプ
sign	string	はい	`key`、`secret`、`timestamp`を連結した文字列を md5 で暗号化して生成

例：

1	http://192.168.31.122:42225/api/v1/task/list?key=06150cad-131c-4a13-88cf-90b7c4e76056&timestamp=1736835697953&sign=1D1802A6A4BB9C8A603F696E1E0E3644

3. レスポンス形式

API レスポンスデータは統一形式に従い、以下のフィールドを含みます：

名称	タイプ	必須	説明
success	boolean	はい	成功かどうか
msg	string	はい	成功メッセージまたはエラー説明
data	object	いいえ	レスポンスのメインデータ

4. インターフェース詳細

4.1 タスク情報の取得（GET）

インターフェース URL：

1	GET task/<id>/info

4.1.1 リクエストパラメータ

名称	タイプ	必須	説明
id	string	はい	タスク ID

4.1.2 响应参数类型

4.1.3 レスポンス例

リクエスト成功時：

{
  "success": true,
  "data": {
    "id": "ngcxb8xzf41x",
    "name": "私の傾斜モデル",
    "status": "failed",
    "type": "GeneralModelSlicing",
    "inputPath": "C:\\Users\\admin\\AppData\\Local\\Temp\\6349b52ac052f1100a0099f56ae1360d",
    "outputPath": "C:\\Users\\admin\\Desktop\\rubbish\\大規模シーン",
    "settings": {
      "fileRange": [2, 20],
      "sceneTree": true,
      "is3DTiles1_1": true,
      "enableLOD": true,
      "textureCompressionFormat": "webp",
      "vertexCompress": false,
      "vertexCompressionLevel": 5,
      "x": 120.14757537841797,
      "y": 30.274856567382812,
      "z": 0,
      "name": "西湖区建築モデル",
      "imageRatio": 0.5
    },
    "startTime": 1736838996442,
    "endTime": 1736841982291
  },
  "msg": "リクエスト成功"
}

リクエスト失敗時：

{
  "success": false,
  "msg": "タスクが見つかりません"
}

4.2 タスクリストの取得（GET）

インターフェース URL：

1	GET task/list

4.2.1 リクエストパラメータ

なし

4.2.2 レスポンスパラメータ

すべてのタスク情報を含む配列。各タスク情報のフィールドは「タスク情報の取得」API を参照してください。

4.2.3 レスポンス例

リクエスト成功時：

{
  "success": true,
  "data": [
    {
      "id": "ngcxb8xzf41x",
      "name": "私の傾斜モデル",
      "status": "running",
      "type": "GeneralModelSlicing",
      "inputPath": "C:\\Users\\admin\\AppData\\Local\\Temp\\6349b52ac052f1100a0099f56ae1360d",
      "outputPath": "C:\\Users\\admin\\Desktop\\rubbish\\大規模シーン",
      "settings": {
        "fileRange": [2, 20],
        "sceneTree": true,
        "is3DTiles1_1": true,
        "enableLOD": true,
        "textureCompressionFormat": "webp",
        "vertexCompress": false,
        "vertexCompressionLevel": 5,
        "x": 120.14757537841797,
        "y": 30.274856567382812,
        "z": 0,
        "name": "西湖区建築モデル",
        "imageRatio": 0.5
      },
      "startTime": 1736838996442,
      "progress": 0,
      "spentTime": 0,
      "remainTime": 0
    },
    {
      "id": "xoeqj7jrw9fl",
      "name": "我的倾斜模型",
      "status": "finished",
      "type": "GeneralModelSlicing",
      "inputPath": "C:\\Users\\admin\\AppData\\Local\\Temp\\c8f9e1d5c211b16dc34c5181922dc911",
      "outputPath": "C:\\Users\\admin\\Desktop\\rubbish\\新しいフォルダー (2)",
      "settings": {
        "fileRange": [2, 20],
        "sceneTree": true,
        "is3DTiles1_1": true,
        "enableLOD": true,
        "textureCompressionFormat": "webp",
        "vertexCompress": false,
        "vertexCompressionLevel": 5,
        "x": 120.19058749999999,
        "y": 30.280553849999997,
        "z": 0,
        "name": "上城区建築モデル",
        "imageRatio": 0.5
      },
      "startTime": 1736838648314,
      "endTime": 1736838670124
    }
  ],
  "msg": "リクエスト成功"
}

リクエスト失敗時：

{
  "success": false,
  "msg": "無効な署名"
}

4.3 タスクの新規作成（POST）

インターフェース URL：

1	POST /task/create

4.3.1 リクエストパラメータ

Body タイプ：

1	application/json

| 名称 | タイプ | 必須 | 説明 |
| :——–: | :—–: | :—-: | ————————————————– | ——————— | ———————– | ————————- | ———————— |
| options | object | はい | |
| type | string | はい | “ImageSlicing” ** | “TerrainSlicing” ** | ** “TiltModelSlicing” | ** “Tiles2OsgbSlicing” ** | ** “PointCloudSlicing” |
| name | string | はい | タスク名 |
| inputPath | string | はい | 入力パス |
| outputPath | string | はい | 出力パス径 |
| autoStart | boolean | いいえ | タスクを即時開始するかどうか（デフォルトはtrue） |
| settings | object | いいえ | 変換オプション |

変換タイプ別の**settings**パラメータの詳細：

（1）イメージタイル

（2）地形タイル

なし

（3）OSGB 转 3DTiles

| 名称 | タイプ | 必須 | 説明 |
| :——————–: | :—–: | :—-: | ————————— | ——– | ————– | ———– |
| srs | string | いいえ | 空間参照 |
| srsOrigin | string | いいえ | ゼロ点座標（例: "0,0,0") |
| isRebuildTop | boolean | いいえ | トップレベル再構築 |
| maxConcurrency | integer | いいえ | 再構築時の最大同時実行数 |
| is3DTiles1_1 | boolean | いいえ | 3DTiles1.1 規格を出力するか |
| textureFormat | string | いいえ | テクスチャ形式（"default" | "webp" | "uastc" | "etc1s"） |
| vertexCompress | boolean | いいえ | 頂点圧縮を行うか |
| vertexCompressionLevel | 0 | 5 | 10 | いいえ | 頂点圧縮レベル |
| computedNormal | boolean | いいえ | 法線を計算するか |
| backFaceCulling | boolean | いいえ | 裏面カリングを行うか |
| mandatoryDoubleSide | boolean | いいえ | 強制的に両面描画するか |
| noLight | boolean | いいえ | ライト無しで出力するか |

（4）3DTiles 转 OSGB

| 名称 | タイプ | 必須 | 説明 |
| :——: | :—–: | :—–: | ———- | ———- |
| srs | string | いいえ | 空間参照 |
| srsOrgin | string | いいえ | ゼロ点座標 |
| upAxis | “Z” | “Y” | いいえ | 上向きの軸 |

（5）点群タイル

| 名称 | タイプ | 必須 | 説明 |
| :——————–: | :—–: | :—-: | ———————————————————- | —— | ————– |
| srs | string | いいえ | 空間参照 |
| srsOrigin | string | いいえ | ゼロ点座標 |
| vertexCompress | boolean | いいえ | 頂点圧縮を行うか |
| vertexCompressionLevel | 0 | 5 | 10 | いいえ | 頂点圧縮レベル |
| colorIpt | number | はい | 色計算式：(color + colorIpt) * colorType / dividendColor |
| colorType | number | はい | |
| dividendColor | number | はい | |
| isSaveColor | boolean | いいえ | 色を保存するか |
| isSelectAttribute | boolean | いいえ | 属性選択を行うか |
| isClassification | boolean | いいえ | |
| isIntensity | boolean | いいえ | |

4.3.2 レスポンスパラメータ

名称	タイプ	必須	制約	中国語名称	説明
id	string	true	none		none

4.3.3 レスポンス例

リクエスト成功時：

{
  "success": true,
  "data": {
    "id": "m2iz285xzzlj"
  },
  "msg": "リクエスト成功"
}

リクエスト失敗時：

{
  "success": false,
  "msg": "Invalid task type"
}

4.4 タスク開始（POST）

インターフェース URL：

1	POST /task/<id>/start

4.4.1 リクエストパラメータ

名称	タイプ	必須	説明
id	string	はい	タスク ID

4.4.2 レスポンスパラメータタイプ

名称	タイプ	必須	説明
id	string	true	タスク ID

4.4.3 レスポンス例

リクエスト成功時：

{
  "success": true,
  "data": {
    "id": "4gtfbeg794p7"
  },
  "msg": "リクエスト成功"
}

リクエスト失敗時：

{
  "success": false,
  "msg": "Task is running"
}

4.5 タスクの終了（POST）

インターフェース URL：

1	POST /task/<id>/stop

4.5.1 リクエストパラメータ

名称	タイプ	必須	説明
id	string	はい	タスク ID

4.5.2 レスポンスパラメータタイプ

名称	タイプ	必須	制約	中国語名称	説明
id	string	true	none		none

4.5.3 レスポンス例

リクエスト成功時：

{
  "success": true,
  "data": {
    "id": "4gtfbeg794p7"
  },
  "msg": "リクエスト成功"
}

リクエスト失敗時：

{
  "success": false,
  "msg": "Task is not running"
}

4.6 タスク削除（POST）

インターフェース URL：

1	POST /task/<id>/delete

4.6.1 リクエストパラメータ

名称	タイプ	必須	説明
id	string	はい	タスク ID

4.6.2 レスポンスパラメータタイプ

名称	タイプ	必須	制約	中国語名称	説明
id	string	true	none		none

4.6.3 レスポンス例

リクエスト成功時：

{
  "success": true,
  "data": {
    "id": "4gtfbeg794p7"
  },
  "msg": "リクエスト成功"
}

リクエスト失敗時：

{
  "success": false,
  "msg": "Task is not running"
}