Table of Contents

API: Mettre à jour les informations Spatial Map

Cette API met à jour les informations de carte via le mapId spécifié. Elle prend en charge une méthode de mise à jour similaire à HTTP PATCH : seuls les paramètres fournis dans la requête sont modifiés, les autres restent inchangés.

1. Informations de base de l'API

  • Adresse de l'API: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • Méthode de requête: PUT
  • Format de requête: multipart/form-data
  • 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 chemin (Path Parameters)

Nom du paramètre Type Obligatoire Description
mapId String Oui Identifiant unique de la Spatial Map (MapId).

3.2 Paramètres de formulaire (Form Parameters)

Comme le format multipart/form-data est utilisé, les paramètres suivants doivent être soumis comme champs de formulaire.

Nom du paramètre Type Obligatoire Description
file File Non Nouveau fichier de données de carte.
name String Non Nom d'affichage de la carte.
gps String Non Coordonnées GPS associées à la carte, par exemple "121.4541,31.2221".
tag String Non Tag de carte.
meta String Non Métadonnées personnalisées, généralement une chaîne encodée en Base64.
clusterInfo String Non Informations liées au cluster.
emeBlocklist String Non Configuration EME blocklist. La valeur par défaut est "[]".

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

Lorsque la requête réussit (statusCode vaut 0), le result renvoyé contient les détails de l'objet carte mis à jour.

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 ARMapDTO mis à jour.

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 en octets.
gps String Informations de coordonnées GPS associées à la carte.
tag String Tag de carte.
meta String Métadonnées personnalisées.
md5 String Somme de contrôle MD5 du fichier de carte mis à jour.
modified DateTime Heure de dernière modification.

5. Codes d'état

Http Code Signification Notes
200 OK Requête réussie.
201 Created Mise à jour réussie et enregistrement associé créé.
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 Le mapId spécifié est introuvable.

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": "updated_office_scene",
    "status": "active",
    "gps": "121.4541,31.2221",
    "modified": "2026-01-30T10:00:00Z"
  }
}