Table of Contents

API: Obtenir la liste des Spatial Map

Cette API permet d'obtenir de manière paginée les informations de liste de toutes les Spatial Map dans la bibliothèque d'images actuelle.

1. Informations de base de l'API

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

2. Authentification

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

  1. Authentification basée sur Token:
    • Header: Authorization: [token]
    • Parameter: AppId doit être inclus.
  2. Authentification basée sur Signature:
    • Utilisez APIKey, APISecret, AppId et les paramètres pour générer une signature de vérification.
    • Pour l'algorithme détaillé de calcul de signature, consultez 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 facultatifs. S'ils ne sont pas renseignés, les valeurs par défaut sont utilisées.

Nom du paramètre Type Obligatoire Par défaut Description
pageNum Integer Non 1 Numéro de page cible demandé.
pageSize Integer Non 10 Nombre maximal de cartes affichées par page.

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

Lorsque la requête réussit (statusCode vaut 0), le result renvoyé contient la liste des cartes et ses métadonnées de pagination.

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

5. Codes d'état

Http Code Signification Notes
200 OK Requête réussie.
401 Unauthorized Échec de l'authentification. Vérifiez le Token ou la signature.
403 Forbidden Pas d'autorisation pour accéder à cette ressource.
404 Not Found Ressource associée introuvable.

Codes d'erreur Status Code

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
}