API-referentie

Alle API's op deze pagina gebruiken POST met een JSON-request body. Elk verzoek gebruikt de Algemene request-headers; die worden niet per API herhaald. De buitenste responsstructuur staat in Uniforme responsstructuur; het onderdeel "Respons" van elke API noemt alleen de zakelijke velden binnen data.

Domeinen

Algemene request-headers

Elke API vereist de volgende headerparameters.

Uniforme responsstructuur

Alle API's geven dezelfde buitenste structuur terug. De buitenste code geeft alleen het resultaat op API-niveau weer; lees data.bizCode voor het zakelijke resultaat.

Opmerking: Een aanroep is alleen geslaagd als zowel code == 0 als data.bizCode == 0.

Taak aanmaken en uploadreferenties ophalen

Maakt een modelleringstaak aan en geeft tijdelijke cloudopslagreferenties uit voor het uploaden van de invoergegevens.

Endpoint

POST /open-apis/spatial-model/v1/model/create

Limieten

Requestparameters

Respons

Requestvoorbeeld

POST /open-apis/spatial-model/v1/model/create HTTP/1.1
Host: open-api-gw.xgrids.com
APP-ID: your_app_id
X-Timestamp: 1791763200
X-Nonce: a3f91c2d8e7b4a6590fd12cb77ae40d1
X-Sign: 9mQk7xL2vTbR4pNw8sYcA1dHfZ3eJgU6oIyK0rVnBsM=
Content-Type: application/json

{
  "modelName": "Design Commune C Facade",
  "modelDes": "Nanshan, Shenzhen, LCC2 scene package",
  "quality": "2",
  "autoRebuild": 1,
  "tags": ["facade", "nanshan"]
}

Responsvoorbeeld

{
  "code": 0,
  "msg": "success",
  "data": {
    "bizCode": 0,
    "bizMsg": "",
    "modelId": 100231987,
    "params": {
      "cloudService": "AWS",
      "endpoint": "s3.ap-southeast-1.amazonaws.com",
      "region": "ap-southeast-1",
      "bucket": "your-bucket-name",
      "savePath": "prd/spatial-model/{accountId}/{taskCode}/input/",
      "accessKeyId": "ASIA****************",
      "accessKeySecret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCY****",
      "securityToken": "IQoJb3JpZ2luX2VjE****",
      "requestId": "b7f1e2a9-5c43-4d8e-9a10-6f2c3b84d517"
    }
  }
}

Taak starten

Start het modelleren handmatig.

Endpoint

POST /open-apis/spatial-model/v1/model/start

Limieten

Requestparameters

Respons

Geeft alleen de Uniforme responsstructuur terug.

Requestvoorbeeld

{
  "modelId": 100231987
}

Uploadreferenties opnieuw ophalen

Haalt nieuwe tijdelijke uploadreferenties op als een upload is onderbroken of de tijdelijke referenties zijn verlopen.

Endpoint

POST /open-apis/spatial-model/v1/model/sts

Limieten

Requestparameters

Respons

Gelijk aan de respons van Taak aanmaken en uploadreferenties ophalen (data.modelId en data.params.*).

Requestvoorbeeld

{
  "modelId": 100231987
}

Uploadstatus bijwerken

Meldt de uploadstatus van de invoergegevens. Je moet deze API aanroepen nadat de upload is voltooid; anders start het modelleren niet.

Endpoint

POST /open-apis/spatial-model/v1/model/upload_status/update

Limieten

Requestparameters

Respons

Geeft alleen de Uniforme responsstructuur terug.

Requestvoorbeeld

{
  "modelId": 100231987,
  "status": 3,
  "uploadTime": 184620
}

Modelleren annuleren

Kan alleen worden aangeroepen voor taken die worden gemodelleerd.

• Alleen taken met de status Bezig met modelleren kunnen worden geannuleerd. Na annulering verandert de taakstatus in Modelleren mislukt.
• Bij annulering worden credits afgeschreven voor het al verbruikte gebruik; extra bevroren credits gaan terug naar het saldo.
• Credits worden meestal binnen enkele minuten verrekend, uiterlijk na ongeveer 10 minuten.

Endpoint

POST /open-apis/spatial-model/v1/model/cancel

Limieten

Requestparameters

Respons

Geeft alleen de Uniforme responsstructuur terug.

Requestvoorbeeld

{
  "modelId": 100231987
}

Takenlijst met paginering

Vraagt modelleringstaken per pagina op, met filters.

Endpoint

POST /open-apis/spatial-model/v1/model/list

Limieten

Requestparameters

Respons

Requestvoorbeeld

{
  "modelName": "Design Commune",
  "statusList": [7, 8],
  "startTime": 1790899200000,
  "endTime": 1791763200000,
  "page": {
    "page": 1,
    "limit": 20,
    "order": "DESC"
  }
}

Taakdetails

Vraagt in batches de details van modelleringstaken op, inclusief statistieken zoals de modelleringsduur.

Endpoint

POST /open-apis/spatial-model/v1/model/detail

Limieten

Requestparameters

Respons

Requestvoorbeeld

{
  "modelIdList": [100231987, 100231988]
}

Accountcredits

Vraagt het creditsaldo op van het account dat aan de appId is gekoppeld.

Endpoint

POST /open-apis/spatial-model/v1/credit/info

Limieten

Requestparameters

Geen zakelijke parameters. Geef een leeg object {} mee.

Respons

Responsvoorbeeld

{
  "code": 0,
  "msg": "success",
  "data": {
    "bizCode": 0,
    "bizMsg": "",
    "availableCredit": 8500,
    "frozenCredit": 1500,
    "totalCredit": 10000
  }
}

Opmerking: Deze API vraagt alleen het creditsaldo van het account op. De factureringsregels voor credits bij modelleringstaken (moment van afschrijving en factureringsgrondslag) worden in een latere versie vastgelegd en gedocumenteerd. In de huidige versie hebben de hier teruggegeven waarden geen invloed op aanroepen van de modellerings-API's.

Modelleringsresultaten downloaden

Haalt tijdelijke downloadlinks op voor de modelleringsuitvoer. Zie Modelleringsuitvoer voor de inhoud.

Endpoint

POST /open-apis/spatial-model/v1/model/data/download

Limieten

Requestparameters

Respons

Requestvoorbeeld

{
  "modelId": 100231987,
  "type": "GLB"
}

Taak verwijderen

Verwijdert een modelleringstaak en de bijbehorende gegevens.

Endpoint

POST /open-apis/spatial-model/v1/model/del

Limieten

Requestparameters

Respons

Geeft alleen de Uniforme responsstructuur terug.

Requestvoorbeeld

{
  "modelId": 100231987
}

Opmerking: Verwijderen kan niet ongedaan worden gemaakt; invoergegevens en modelleringsuitvoer worden samen verwijderd. Voeg aan jouw kant een tweede bevestiging toe.