Table of Contents

Introdução às APIs de gerenciamento de mapas espaciais esparsos

Lista de APIs

Protocolo de interface REST API e mecanismo de autenticação

A Spatial Map API segue o padrão de transmissão HTTP REST.

Cabeçalho HTTP

    Authorization:

Parâmetros de solicitação HTTP, divididos em dois tipos:

  • Parâmetros comuns (incluem estes, diferentes combinações de autenticação usam diferentes):

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

  • Parâmetros da API Spatial Map: parâmetros específicos da API

    A documentação da API não descreve mais os parâmetros comuns de autenticação

Autenticação por API Key

Existem dois métodos de autenticação.

Autenticação baseada em Token

O cabeçalho HTTP Authorization contém o Token, os parâmetros comuns incluem:

  • appId

Autenticação por assinatura

Não utiliza o cabeçalho HTTP Authorization.

Os parâmetros da solicitação contêm a assinatura signature. Todos os parâmetros são incluídos no cálculo da assinatura (exceto imagens).

  • appId
  • timestamp
  • apiKey
  • signature

Para o algoritmo detalhado de cálculo de assinatura, consulte o documento Método de assinatura API Key.

Exemplos de uso e análise de atributos

Exemplo de uso da API

Aqui está um exemplo — chamando a interface da API para consultar dados do mapa Spatial Map, ajudando os desenvolvedores a entender a interface da API 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
}

Atributos do mapa esparso

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

Atributo Descrição
mapId ID único do mapa
name Nome do mapa
size Tamanho do arquivo do mapa
meta Dados associados pelo usuário, podem ser arquivo, texto ou URL, codificados em base64
status Se está desativado, dois valores [active inactive]
tag Etiqueta personalizada, para facilitar a pesquisa
floor Andar, para facilitar a pesquisa
gps Localização geográfica do espaço, sistema de coordenadas wgs84, ou pode usar seu próprio sistema de coordenadas
previewUrl Download da imagem de pré-visualização

Códigos de erro

Tópicos relacionados