Table of Contents

Introduction aux APIs de gestion des cartes spatiales éparses

Liste complète des APIs

Protocole d'interface REST API et mécanisme d'authentification

Les APIs Spatial Map suivent les standards de transmission HTTP REST.

En-têtes HTTP

    Authorization: <Insérer le Token obtenu via APIKey>

Paramètres de requête HTTP, divisés en deux types :

  • Paramètres communs (inclus globalement, l'authentification détermine leur combinaison) :

    • appId
    • timestamp (Long : millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC)
    • apiKey
    • signature (signature de requête, alternative au token)

  • Paramètres spécifiques aux APIs Spatial Map : paramètres propres à chaque API

    Les paramètres d'authentification communs ne sont pas décrits dans la documentation des APIs

Authentification par API Key

Deux méthodes d'authentification sont disponibles.

Authentification basée sur Token

L'en-tête HTTP Authorization contient le Token. Les paramètres communs incluent :

  • appId

Authentification par signature

Aucun en-tête HTTP Authorization utilisé.

Les paramètres de requête contiennent la signature. Tous les paramètres sont inclus dans le calcul de signature (sauf les images).

  • appId
  • timestamp
  • apiKey
  • signature

Pour l'algorithme détaillé de calcul de signature, consultez Méthode de signature API Key.

Exemples d'utilisation et analyse des attributs

Exemple d'utilisation d'API

Cet exemple illustre l'appel d'une API pour interroger des données de carte spatiale, aidant les développeurs à comprendre la structure des APIs et des cartes spatiales.

Exemple de requête

  GET /maps HTTP/1.1
  Host:
  Date: Mon, 1 Jan 2018 00:00:00 GMT
  Content-Type: application/json
  {
      "timestamp": 1769406019000,
      "apiKey": "8b485c648c3056e79c2a85ee9b...",
      "appId": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9..",
      "signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
  }

Exemple de réponse

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

Attributs des cartes éparses

Comme illustré ci-dessus, voici la structure normale d'une carte spatiale

Attribut Description
mapId ID unique de la carte
name Nom de la carte
size Taille du fichier de carte
meta Données associées utilisateur (texte, fichier ou URL), encodage base64 requis
status État d'activation [active inactive]
tag Étiquette personnalisée pour la recherche
floor Étage pour la recherche
gps Coordonnées géographiques (système wgs84 ou personnalisé)
previewUrl Téléchargement de l'aperçu

Codes d'erreur

Sujets connexes