Table of Contents

API —— Obter URL de download de metadados

Esta interface é usada para obter informações de recursos de download de metadados associados a um Spatial Map (mapa espacial) específico através do mapId.

1. Informação básica da interface

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

2. Método de autenticação

Esta interface suporta dois modos de autenticação:

  1. Baseado em Token:
    • Header: Authorization: [token]
    • Parâmetro: Requer AppId.
  2. Baseado em assinatura (Signature):
    • Usa APIKey, APISecret e AppId para gerar uma assinatura para verificação.
    • Para o algoritmo detalhado de cálculo de assinatura, consulte Método de assinatura de API Key.

3. Parâmetros de solicitação

3.1 Parâmetros de caminho (Path Parameters)

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

4. Estrutura de dados de resposta (Resource)

Quando a solicitação é bem-sucedida (statusCode 0), o resultado result conterá um objeto Resource apontando para o arquivo de metadados.

Nome do 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 Object Objeto Map contendo array de dados do mapa e informações de paginação.

Estrutura do objeto Resource:

Nome do campo Tipo Descrição
filename String Nome do arquivo de metadados.
url Object (URL) Objeto contendo informações detalhadas do URL de download (protocolo, host, caminho, etc.).
file Object (File) Informações físicas do arquivo (caminho, tamanho, etc.).
readable Boolean Indica se o recurso é legível.
open Boolean Indica se o recurso está atualmente aberto.

5. Códigos de status (Status Codes)

Código HTTP Significado Descrição
200 OK Solicitação bem-sucedida.
401 Unauthorized Falha na autenticação. Verifique o Token ou assinatura.
403 Forbidden Acesso não autorizado ao recurso.
404 Not Found Mapa ou metadados especificados não encontrados.

Explicação dos 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
  }
}