Table of Contents

API - Rechercher des cartes Spatial Map

Cette interface sert à rechercher des cartes Spatial Map. Tous les paramètres de recherche sont facultatifs. Lorsque plusieurs champs sont utilisés pour la recherche, le système relie les conditions avec la logique "AND".

1. Informations de base de l'interface

  • Adresse de l'interface: https://armap-api-<cn1,na1>.easyar.com/map
  • 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:

  1. Authentification basée sur Token:
    • Header: Authorization: [token]
    • Paramètre: AppId doit être inclus.
  2. Authentification basée sur la signature (Signature):
    • Utilisez APIKey, APISecret, AppId et les paramètres pour générer une signature pour la 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 Query parameters

Tous les paramètres de recherche sont facultatifs.

Nom du paramètre Type Obligatoire Valeur par défaut Description
gps String Non - Recherche les cartes proches de cette coordonnée GPS.
range Number Non 1.0 Plage de recherche (unité: km). Doit être utilisé avec le paramètre gps.
name String Non - Recherche par nom de carte.
tag String Non - Recherche par tag de carte.

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

Lorsque la requête réussit (statusCode vaut 0), le result renvoyé contient un tableau d'objets carte correspondant aux conditions.

Nom du champ Type Description
statusCode Integer Code d'état. 0 indique la réussite.
msg String Informations de description de l'état.
timestamp DateTime Horodatage de la réponse du serveur.
result Array Tableau contenant des objets ARMapDTO.

Structure de l'objet ARMapDTO

Nom du champ Type Description
mapId String Identifiant unique de la carte.
name String Nom de la carte.
status String État actuel de la carte.
size Integer (int64) Taille du fichier de carte.
gps String Informations de coordonnées GPS associées à la carte.
tag String Tag de carte.
meta String Metadata personnalisées.
created DateTime Heure de création.
modified DateTime Heure de dernière modification.

5. Status codes

Http Code Signification Description
200 OK Requête réussie.
401 Unauthorized Échec de l'authentification. Vérifiez le Token ou la signature.
403 Forbidden Aucun droit d'accès à cette ressource.

Codes d'erreur Status Code

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