Table of Contents

API: Aggiornare le informazioni Spatial Map

Questa API aggiorna le informazioni della mappa tramite il mapId specificato. Supporta un metodo di aggiornamento simile a HTTP PATCH: vengono modificati solo i parametri forniti nella richiesta, mentre quelli non forniti restano invariati.

1. Informazioni di base dell'API

  • Indirizzo API: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • Metodo di richiesta: PUT
  • Formato richiesta: multipart/form-data
  • Formato risposta: */* (di solito application/json)

2. Autenticazione

Questa API supporta i due seguenti modi di autenticazione:

  1. Autenticazione basata su Token:
    • Header: Authorization: [token]
    • Parameter: È necessario includere AppId.
  2. Autenticazione basata su Signature:
    • Usare APIKey, APISecret, AppId e i parametri per generare una signature per la verifica.
    • Per l'algoritmo dettagliato di calcolo della signature, vedere metodo di firma API Key.

3. Parametri della richiesta

3.1 Parametri path (Path Parameters)

Nome parametro Tipo Obbligatorio Descrizione
mapId String Identificatore univoco della Spatial Map (MapId).

3.2 Parametri form (Form Parameters)

Poiché viene usato multipart/form-data, i seguenti parametri devono essere inviati come campi form.

Nome parametro Tipo Obbligatorio Descrizione
file File No Nuovo file dati della mappa.
name String No Nome visualizzato della mappa.
gps String No Coordinate GPS associate alla mappa, ad esempio "121.4541,31.2221".
tag String No Tag della mappa.
meta String No Metadati personalizzati, di solito una stringa codificata Base64.
clusterInfo String No Informazioni relative al cluster.
emeBlocklist String No Configurazione blocklist EME. Il valore predefinito è "[]".

4. Struttura dei dati di risposta (ARMapDTO)

Quando la richiesta riesce (statusCode è 0), il result restituito contiene i dettagli dell'oggetto mappa aggiornato.

Nome campo Tipo Descrizione
statusCode Integer Codice di stato. 0 indica successo.
msg String Informazioni descrittive dello stato.
timestamp DateTime Timestamp di risposta del server.
result Object Oggetto ARMapDTO aggiornato.

Struttura oggetto ARMapDTO

Nome campo Tipo Descrizione
mapId String Identificatore univoco della mappa.
name String Nome della mappa.
status String Stato corrente della mappa.
size Integer (int64) Dimensione del file mappa in byte.
gps String Informazioni coordinate GPS associate alla mappa.
tag String Tag della mappa.
meta String Metadati personalizzati.
md5 String Checksum MD5 del file mappa aggiornato.
modified DateTime Ora dell'ultima modifica.

5. Codici di stato

Http Code Significato Note
200 OK Richiesta riuscita.
201 Created Aggiornamento riuscito e record correlato creato.
401 Unauthorized Autenticazione non riuscita. Controllare Token o signature.
403 Forbidden Nessun permesso per accedere a questa risorsa.
404 Not Found Il mapId specificato non è stato trovato.

Codici errore Status Code

6. Risposta di esempio (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
    "name": "updated_office_scene",
    "status": "active",
    "gps": "121.4541,31.2221",
    "modified": "2026-01-30T10:00:00Z"
  }
}