Table of Contents

API —— Obter lista de mapas Spatial Map

Esta interface é usada para obter paginadamente a lista de informações de todos os Spatial Maps (mapas espaciais) no galeria atual.

1. Informações básicas da interface

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

2. Método de autenticação

Esta interface suporta os seguintes dois modos de autenticação:

  1. Autenticação baseada em Token:
    • Cabeçalho: Authorization: [token]
    • Parâmetros: Deve incluir AppId.
  2. Autenticação baseada em assinatura (Signature):
    • Usa 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 API Key.

3. Parâmetros de solicitação

3.1 Parâmetros de consulta (Query Parameters)

Os parâmetros de paginação são opcionais. Se não forem preenchidos, os valores padrão serão usados.

Nome do parâmetro Tipo Obrigatório Valor padrão Descrição
pageNum Integer Não 1 Número da página de destino solicitada.
pageSize Integer Não 10 Número máximo de mapas exibidos por página.

4. Estrutura de dados de resposta (ResponseResult)

Quando a solicitação é bem-sucedida (statusCode é 0), o resultado result conterá a lista de mapas e seus metadados de paginação.

Nome do campo Tipo Descrição
statusCode Integer Código de status. 0 representa sucesso.
msg String Mensagem descritiva do status.
timestamp DateTime Carimbo de data/hora da resposta do servidor.
result Object Objeto Map que contém o array de dados do mapa e informações de estatísticas de paginação.

5. Códigos de status

Código HTTP Significado Explicaçã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.
404 Not Found Recurso não encontrado.

Códigos de erro Status Code

6. Exemplo de resposta (JSON)

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