Table of Contents

Api —— rechercher la carte spatiale

Cette interface est utilisée pour rechercher des cartes spatiales (Spatial Map). Tous les paramètres de recherche sont facultatifs. Lorsque plusieurs champs sont utilisés pour la recherche, le système connecte les conditions via une logique "AND".

1. Informations de base sur 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 deux modes d'authentification :

  1. Authentification basée sur un jeton :
    • Header : Authorization: [token]
    • Paramètre : doit inclure AppId.
  2. Authentification basée sur une 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 signature, reportez-vous à Méthode de signature de la clé API.

3. Paramètres de la requête

3.1 Paramètres de requête (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 à proximité de ces coordonnées GPS.
range Number Non 1.0 Rayon de recherche (en km). Doit être utilisé avec le paramètre gps.
name String Non - Recherche par nom de carte.
tag String Non - Recherche par étiquette (tag) de carte.

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

Lorsque la requête réussit (statusCode est 0), le résultat result contiendra un tableau d'objets carte correspondant aux critères.

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 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 la carte.
gps String Informations sur les coordonnées GPS associées à la carte.
tag String Étiquette (tag) de la carte.
meta String Méta-données personnalisées.
created DateTime Date et heure de création.
modified DateTime Date et heure de dernière modification.

5. Codes d'état (status codes)

Code Http Signification Explication
200 OK Requête réussie.
401 Unauthorized Échec de l'authentification, vérifiez le jeton ou la signature.
403 Forbidden Accès non autorisé à la ressource.

Explication des codes d'erreur statusCode

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"
    }
  ]
}