Api —— pesquisa de mapa spatial map

Esta interface é usada para pesquisar spatial map (mapa espacial). Os parâmetros de pesquisa são opcionais. Quando vários campos são usados para pesquisa, o sistema conectará cada condição com lógica "AND".

1. Informações básicas da interface

• Endpoint: https://armap-api-<cn1,na1>.easyar.com/map
• Método: GET
• Formato de resposta: */* (normalmente application/json)

2. Método de autenticação

Esta interface suporta dois modos de autenticação:

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

3. Parâmetros de requisição

3.1 Parâmetros de consulta (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 a esta coordenada GPS.
range	Number	Não	1.0	Alcance de pesquisa (unidade: km). Deve ser usado com 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 de resposta (ARMapDTO)

Quando a requisição é bem-sucedida (statusCode 0), o resultado result conterá um array de objetos de mapa que atendem aos critérios.

Campo	Tipo	Descrição
statusCode	Integer	Código de status. 0 indica sucesso.
msg	String	Mensagem descritiva do status.
timestamp	DateTime	Timestamp da resposta do servidor.
result	Array	Array contendo objetos ARMapDTO.

Estrutura do objeto ARMapDTO

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 coordenada GPS associadas ao mapa.
tag	String	Tag do mapa.
meta	String	Metadados personalizados.
created	DateTime	Data de criação.
modified	DateTime	Data da última modificação.

5. Códigos de status (status codes)

Código HTTP	Significado	Explicação
200	OK	Requisição bem-sucedida.
401	Unauthorized	Falha na autenticação. Verifique token ou assinatura.
403	Forbidden	Acesso não autorizado ao recurso.

Explicação dos códigos de erro status code

• Explicação dos códigos de erro de APIs de spatial map

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