Table of Contents

API - Obter o endereço de download dos dados meta

Esta interface é usada para obter, por meio de mapId, as informações do recurso de download dos metadata (meta) associados ao Spatial Map especificado.

1. Informações básicas da interface

  • Endereço da interface: https://armap-api-<cn1,na1>.easyar.com/map/meta/{mapId}
  • 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 e AppId 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 Path parameters

Nome do parâmetro Tipo Obrigatório Descrição
mapId String Sim Identificador único do mapa espacial (MapId).

4. Estrutura de dados da resposta (Resource)

Quando a solicitação é bem-sucedida (statusCode é 0), o result retornado contém um objeto Resource que aponta para o arquivo metadata.

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 Object Objeto Map contendo o array de dados do mapa e estatísticas de paginação.

Estrutura do objeto Resource:

Nome do campo Tipo Descrição
filename String Nome do arquivo metadata.
url Object (URL) Objeto contendo informações detalhadas do endereço de download, como protocol, host e path.
file Object (File) Informações de propriedades físicas do arquivo, como path e size.
readable Boolean Se este recurso pode ser lido.
open Boolean Se este recurso está atualmente aberto.

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.
404 Not Found O mapa ou metadata especificados não foram encontrados.

Códigos de erro de Status Code

6. Exemplo de resposta (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "filename": "map_metadata.json",
    "url": {
      "protocol": "https",
      "host": "armap-api-cn1.easyar.com",
      "path": "/download/path/to/meta",
      "query": "token=..."
    },
    "readable": true,
    "open": false
  }
}