API: Ottenere l'elenco Spatial Map

Questa API viene usata per ottenere in modo paginato le informazioni dell'elenco di tutte le Spatial Map nella libreria immagini corrente.

1. Informazioni di base dell'API

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

2. Autenticazione

Questa API supporta i due seguenti modi di autenticazione:

Autenticazione basata su Token:
- Header: Authorization: [token]
- Parameter: È necessario includere AppId.
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 query (Query Parameters)

I parametri di paginazione sono opzionali. Se non compilati, saranno usati i valori predefiniti.

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

4. Struttura dei dati di risposta (ResponseResult)

Quando la richiesta riesce (statusCode è 0), il result restituito contiene l'elenco delle mappe e i metadati di paginazione.

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 Map che contiene array di dati mappa e statistiche di paginazione.

5. Codici di stato

Http Code	Significato	Note
200	OK	Richiesta riuscita.
401	Unauthorized	Autenticazione non riuscita. Controllare Token o signature.
403	Forbidden	Nessun permesso per accedere a questa risorsa.
404	Not Found	Risorsa correlata non trovata.

Codici errore Status Code

Descrizione dei codici di stato Sparse Spatial Map APIs

6. Risposta di esempio (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