Table of Contents

API - Pesquisar mapas Spatial Map

Esta interface é usada para pesquisar mapas Spatial Map. Todos os parâmetros de pesquisa são opcionais. Quando vários campos são usados para pesquisa, o sistema conecta as condições com lógica "AND".

1. Informações básicas da interface

  • Endereço da interface: https://armap-api-<cn1,na1>.easyar.com/map
  • Método de solicitação: GET
  • Formato de resposta: */* (geralmente application/json)

2. Método de autenticação

Esta interface oferece suporte aos dois modos de autenticação a seguir:

  1. Autenticação baseada em Token:
    • Header: Authorization: [token]
    • Parâmetro: deve incluir AppId.
  2. Autenticação baseada em assinatura (Signature):
    • Use APIKey, APISecret, AppId e parâmetros para gerar uma assinatura para verificação.
    • Para o algoritmo detalhado de cálculo da assinatura, consulte método de assinatura de API Key.

3. Parâmetros da solicitação

3.1 Query parameters

Todos os parâmetros de pesquisa são opcionais.

Nome do parâmetro Tipo Obrigatório Valor padrão Descrição
gps String Não - Pesquisa mapas próximos desta coordenada GPS.
range Number Não 1.0 Intervalo de pesquisa (unidade: km). Deve ser usado junto com o parâmetro gps.
name String Não - Pesquisa por nome do mapa.
tag String Não - Pesquisa por tag do mapa.

4. Estrutura de dados da resposta (ARMapDTO)

Quando a solicitação é bem-sucedida (statusCode é 0), o result retornado contém um array de objetos de mapa que atendem às condições.

Nome do campo Tipo Descrição
statusCode Integer Código de status. 0 representa sucesso.
msg String Informações de descrição do status.
timestamp DateTime Timestamp da resposta do servidor.
result Array Array contendo objetos ARMapDTO.

Estrutura do objeto ARMapDTO

Nome do campo Tipo Descrição
mapId String Identificador único do mapa.
name String Nome do mapa.
status String Status atual do mapa.
size Integer (int64) Tamanho do arquivo do mapa.
gps String Informações de coordenadas GPS associadas ao mapa.
tag String Tag do mapa.
meta String Metadata customizados.
created DateTime Hora de criação.
modified DateTime Hora da última modificação.

5. Status codes

Http Code Significado Descrição
200 OK Solicitação bem-sucedida.
401 Unauthorized Falha na autenticação. Verifique o Token ou a assinatura.
403 Forbidden Sem permissão para acessar este recurso.

Códigos de erro de Status Code

6. Exemplo de resposta (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": [
    {
      "mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
      "name": "office_scene",
      "status": "active",
      "gps": "121.4541,31.2221",
      "tag": "indoor"
    }
  ]
}