API: Obter lista de Spatial Map

Esta API é usada para obter de forma paginada as informações de lista de todos os Spatial Maps na biblioteca de imagens atual.

1. Informações básicas da API

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

2. Autenticação

Esta API suporta os dois modos de autenticação a seguir:

Autenticação baseada em Token:
- Header: Authorization: [token]
- Parameter: AppId deve ser incluído.
Autenticação baseada em Signature:
- Use APIKey, APISecret, AppId e os parâmetros para gerar uma signature de verificação.
- Para o algoritmo detalhado de cálculo da signature, consulte método de assinatura API Key.

3. Parâmetros da requisição

3.1 Parâmetros de consulta (Query Parameters)

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

Nome do parâmetro	Tipo	Obrigatório	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 da resposta (ResponseResult)

Quando a requisição é bem-sucedida (statusCode é 0), o result retornado contém a lista de mapas e seus metadados de paginação.

Nome do campo	Tipo	Descrição
statusCode	Integer	Código de status. 0 indica sucesso.
msg	String	Informação descritiva do status.
timestamp	DateTime	Timestamp de resposta do servidor.
result	Object	Objeto Map contendo array de dados de mapas e estatísticas de paginação.

5. Códigos de status

Http Code	Significado	Observações
200	OK	Requisição bem-sucedida.
401	Unauthorized	Falha na autenticação. Verifique o Token ou a signature.
403	Forbidden	Sem permissão para acessar este recurso.
404	Not Found	Recurso relacionado não encontrado.

Códigos de erro de Status Code

Descrição dos códigos de status de Sparse Spatial Map APIs

6. Resposta de exemplo (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
}

Table of Contents