API —— Obtenir la liste des cartes Spatial Map

Cette interface permet d'obtenir de manière paginée les informations de liste de toutes les cartes Spatial Map (carte spatiale) sous la bibliothèque actuelle.

1. Informations de base de l'interface

Adresse de l'interface : https://armap-api-<cn1,na1>.easyar.com/maps
Méthode de requête : GET
Format de réponse : */* (généralement application/json)

2. Méthode d'authentification

Cette interface prend en charge les deux modes d'authentification suivants :

Authentification basée sur Token :
- Header : Authorization: [token]
- Paramètre : Doit inclure AppId.
Authentification basée sur la signature (Signature) :
- Utilise APIKey, APISecret, AppId et les paramètres pour générer une signature de vérification.
- Pour l'algorithme détaillé du calcul de la signature, reportez-vous à Méthode de signature API Key.

3. Paramètres de requête

3.1 Paramètres de requête (Query Parameters)

Les paramètres de pagination sont optionnels. Les valeurs par défaut seront utilisées s'ils ne sont pas fournis.

Nom du paramètre	Type	Obligatoire	Valeur par défaut	Description
pageNum	Integer	Non	1	Numéro de page cible de la requête.
pageSize	Integer	Non	10	Nombre maximum de cartes affichées par page.

4. Structure de données de réponse (ResponseResult)

Lorsque la requête réussit (statusCode est 0), le résultat result contiendra la liste des cartes et leurs métadonnées de pagination.

Nom du champ	Type	Description
statusCode	Integer	Code d'état. 0 indique le succès.
msg	String	Message descriptif de l'état.
timestamp	DateTime	Horodatage de la réponse du serveur.
result	Object	Objet Map contenant le tableau de données des cartes et les informations de statistiques de pagination.

5. Codes d'état

Code Http	Signification	Explication
200	OK	Requête réussie.
401	Unauthorized	Échec de l'authentification, veuillez vérifier le Token ou la signature.
403	Forbidden	Accès non autorisé à la ressource.
404	Not Found	Ressource non trouvée.

Status Code Codes d'erreur

Explication des codes d'erreur des APIs de carte spatiale éparse

6. Exemple de réponse (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