Table of Contents

Introduction aux APIs de gestion des Sparse Spatial Map

Vue d'ensemble de l'API

Protocole REST de l'API et mécanisme d'authentification

Spatial Map API suit la spécification standard de transport HTTP REST.

En-tête HTTP

    Authorization: <renseignez le Token obtenu à partir de l'APIKey>

Les paramètres de requête HTTP sont divisés en deux types :

  • Paramètres publics (tous ceux-ci sont inclus ; ils sont utilisés différemment selon le mode d'authentification) :

    • appId
    • timestamp (entier Long : millisecondes écoulées depuis 00:00:00 UTC le 1er janvier 1970)
    • apiKey
    • signature (signature de requête, choisissez l'authentification par token ou l'authentification par signature)

  • Paramètres de Spatial Map API : les paramètres propres à l'API

    La documentation de l'API ne décrit plus les paramètres publics utilisés pour l'authentification

Authentification par API Key

Il existe deux méthodes d'authentification.

Authentification basée sur un token

L'en-tête HTTP Authorization contient le Token, et les paramètres publics incluent :

  • appId

Authentification par signature

N'utilisez pas l'en-tête HTTP Authorization.

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

  • appId
  • timestamp
  • apiKey
  • signature

Pour l'algorithme détaillé du calcul de la signature, veuillez consulter la méthode de signature API Key.

Exemples d'utilisation et interprétation des propriétés

Exemple d'utilisation de l'API

L'exemple suivant utilise un appel API pour interroger les données Spatial Map afin d'aider les développeurs à comprendre l'API Spatial Map et la structure de la carte spatiale.

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
}

Propriétés de la Sparse Map

Comme indiqué dans l'exemple ci-dessus, il s'agit de la structure Spatial Map normalement renvoyée

Propriété Description
mapId ID unique de la carte
name Nom de la carte
size Taille du fichier de la carte
meta Données associées à l'utilisateur, qui peuvent être un fichier, du texte ou une URL, et doivent être encodées en base64
status Indique si elle est désactivée, valeurs [active inactive]
tag Balise personnalisée pour faciliter la recherche
floor Étage pour faciliter la recherche
gps Emplacement géographique de l'espace, système de coordonnées wgs84, ou système de coordonnées défini par l'utilisateur
previewUrl Téléchargement de l'image d'aperçu

Codes d'erreur

Sujets associés