Table of Contents

Introdução às APIs de gerenciamento de Sparse Spatial Map

Visão geral da API

Protocolo REST da API e mecanismo de autenticação

Spatial Map API segue a especificação padrão de transporte HTTP REST.

Cabeçalho HTTP

    Authorization:

Os parâmetros da solicitação HTTP são divididos em dois tipos:

  • Parâmetros públicos (todos estes estão incluídos; eles são usados de forma diferente dependendo do método de autenticação):

    • appId
    • timestamp (inteiro Long: milissegundos decorridos desde 00:00:00 UTC de 1 de janeiro de 1970)
    • apiKey
    • signature (assinatura da solicitação, escolha autenticação por token ou autenticação por assinatura)

  • Parâmetros da Spatial Map API: os próprios parâmetros da API

    A documentação da API não descreve mais os parâmetros públicos usados para autenticação

Autenticação de API Key

Há dois métodos de autenticação.

Autenticação baseada em token

O cabeçalho HTTP Authorization contém o Token, e os parâmetros públicos incluem:

  • appId

Autenticação por assinatura

Não use o cabeçalho HTTP Authorization.

Os parâmetros da solicitação contêm as informações de assinatura. Todos os parâmetros entram no cálculo da assinatura (exceto a imagem).

  • appId
  • timestamp
  • apiKey
  • signature

Para o algoritmo detalhado do cálculo da assinatura, consulte o método de assinatura da API Key.

Exemplos de uso e interpretação de propriedades

Exemplo de uso da API

O exemplo a seguir usa uma chamada de API para consultar dados de Spatial Map e ajudar os desenvolvedores a entender a API de Spatial Map e a estrutura do mapa espacial.

Exemplo de solicitação

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

Exemplo de resposta

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

Propriedades de Sparse Map

Como mostrado no exemplo acima, esta é a estrutura Spatial Map normalmente retornada

Propriedade Descrição
mapId ID exclusivo do mapa
name Nome do mapa
size Tamanho do arquivo do mapa
meta Dados associados ao usuário, que podem ser arquivo, texto ou url, e precisam ser codificados em base64
status Se está desativado, os valores são [active inactive]
tag Tag personalizada para facilitar a busca
floor Andar para facilitar a busca
gps Localização geográfica do espaço, sistema de coordenadas wgs84 ou um sistema de coordenadas definido pelo usuário
previewUrl Download da imagem de pré-visualização

Códigos de erro

Tópicos relacionados