API —— Ottenere l'elenco delle mappe Spatial Map

Questa interfaccia viene utilizzata per ottenere in modo paginato le informazioni dell'elenco di tutte le mappe Spatial Map (mappe spaziali) nella galleria corrente.

1. Informazioni di base dell'interfaccia

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

2. Metodo di autenticazione

Questa interfaccia supporta due modalità di autenticazione:

Autenticazione basata su Token:
- Header: Authorization: [token]
- Parametri: richiede AppId.
Autenticazione basata su firma (Signature):
- Utilizza APIKey, APISecret, AppId e parametri per generare una firma per la verifica.
- Per l'algoritmo dettagliato di calcolo della firma, fare riferimento a Metodo di firma API Key.

3. Parametri di richiesta

3.1 Parametri query (Query Parameters)

I parametri di paginazione sono opzionali. Se non specificati, verranno utilizzati i valori predefiniti.

Nome parametro	Tipo	Obbligatorio	Valore predefinito	Descrizione
pageNum	Integer	No	1	Numero di pagina target della richiesta.
pageSize	Integer	No	10	Numero massimo di mappe visualizzate per pagina.

4. Struttura dati di risposta (ResponseResult)

Quando la richiesta ha successo (statusCode è 0), il risultato result conterrà l'elenco delle mappe e i metadati di paginazione.

Nome campo	Tipo	Descrizione
statusCode	Integer	Codice di stato. 0 indica successo.
msg	String	Messaggio descrittivo dello stato.
timestamp	DateTime	Timestamp di risposta del server.
result	Object	Oggetto Map contenente l'array di dati delle mappe e le informazioni statistiche di paginazione.

5. Codici di stato

Http Code	Significato	Spiegazione
200	OK	Richiesta riuscita.
401	Unauthorized	Autenticazione fallita, verificare Token o firma.
403	Forbidden	Accesso non autorizzato alla risorsa.
404	Not Found	Risorsa non trovata.

Status Code codici di errore

Spiegazione codici errore APIs mappe spaziali sparse

6. Esempio di risposta (JSON)

{
  "result": {
    "armaps": [
      {
        "mapId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "gps": "[0.0, 0.0]",
        "name": "Map_2020-09-28_1302",
        "size": 124140,
        "status": "active",
        "auxiliaryId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "created": 1601245841687,
        "modified": 1601245841687,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "appKey": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9f.."
      },
      {
        "mapId": "5ccdf1fb-0cd3-4580-80aa-42bd2289...",
        "gps": "[0.0, 0.0]",
        "name": "test",
        "size": 2419184,
        "status": "active",
        "auxiliaryId": "5ccdf1fb-0cd3-4580-80aa-42bd22897b...",
        "floor": "1",
        "tag": "cat",
        "created": 1601244090670,
        "modified": 1601244090670,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley....",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...."
      }
    ],
    "page": {
      "total": 2,
      "pageNum": 1,
      "pageSize": 10,
      "pages": 1
    }
  },
  "statusCode": 0,
  "msg": "Success",
  "timestamp": 1769406021019
}

Table of Contents