Table of Contents

API —— ricerca Spatial Map

Questa interfaccia è utilizzata per cercare Spatial Map (mappe spaziali). I parametri di ricerca sono tutti opzionali. Quando si utilizzano più campi per la ricerca, il sistema collegherà le condizioni tramite logica "AND".

1. Informazioni di base dell'interfaccia

  • Endpoint: https://armap-api-<cn1,na1>.easyar.com/map
  • Metodo richiesta: GET
  • Formato risposta: */* (solitamente application/json)

2. Metodi di autenticazione

Questa interfaccia supporta due modalità di autenticazione:

  1. Autenticazione basata su Token:
    • Header: Authorization: [token]
    • Parametro: Richiede AppId.
  2. Autenticazione basata su Firma (Signature):
    • Utilizza APIKey, APISecret, AppId e i parametri per generare una firma di verifica.
    • Per l'algoritmo dettagliato di calcolo della firma, consultare Metodo di firma API Key.

3. Parametri della richiesta

3.1 Parametri di query (Query Parameters)

Tutti i parametri di ricerca sono opzionali.

Nome parametro Tipo Obbligatorio Valore predefinito Descrizione
gps String No - Cerca mappe vicine a queste coordinate GPS.
range Number No 1.0 Raggio di ricerca (unità: km). Deve essere usato con il parametro gps.
name String No - Cerca per nome della mappa.
tag String No - Cerca per tag associato alla mappa.

4. Struttura dati della risposta (ARMapDTO)

Quando la richiesta ha successo (statusCode 0), il risultato result conterrà un array di oggetti mappa che corrispondono ai criteri.

Nome campo Tipo Descrizione
statusCode Integer Codice di stato. 0 indica successo.
msg String Messaggio descrittivo dello stato.
timestamp DateTime Timestamp della risposta del server.
result Array Array contenente oggetti ARMapDTO.

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 della mappa.
gps String Informazioni sulle coordinate GPS associate alla mappa.
tag String Tag della mappa.
meta String Metadati personalizzati.
created DateTime Data e ora di creazione.
modified DateTime Data e ora dell'ultima modifica.

5. Codici di stato (Status Codes)

Codice HTTP Significato Spiegazione
200 OK Richiesta riuscita.
401 Unauthorized Autenticazione fallita, verificare Token o firma.
403 Forbidden Accesso alla risorsa non autorizzato.

Spiegazione codici errore Status Code

6. Esempio di risposta (JSON)

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