Table of Contents

API: Atualizar informações de Spatial Map

Esta API atualiza informações do mapa pelo mapId especificado. Ela suporta um método de atualização semelhante a HTTP PATCH: apenas os parâmetros fornecidos na requisição são modificados, e os não fornecidos permanecem inalterados.

1. Informações básicas da API

  • Endereço da API: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • Método da requisição: PUT
  • Formato da requisição: multipart/form-data
  • Formato da resposta: */* (normalmente application/json)

2. Autenticação

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

  1. Autenticação baseada em Token:
    • Header: Authorization: [token]
    • Parameter: AppId deve ser incluído.
  2. 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 caminho (Path Parameters)

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

3.2 Parâmetros de formulário (Form Parameters)

Como multipart/form-data é usado, os seguintes parâmetros devem ser enviados como campos de formulário.

Nome do parâmetro Tipo Obrigatório Descrição
file File Não Novo arquivo de dados do mapa.
name String Não Nome de exibição do mapa.
gps String Não Coordenadas GPS associadas ao mapa, por exemplo "121.4541,31.2221".
tag String Não Tag do mapa.
meta String Não Metadados personalizados, normalmente uma string codificada em Base64.
clusterInfo String Não Informações relacionadas ao cluster.
emeBlocklist String Não Configuração de blocklist EME. O padrão é "[]".

4. Estrutura de dados da resposta (ARMapDTO)

Quando a requisição é bem-sucedida (statusCode é 0), o result retornado contém os detalhes do objeto de mapa atualizado.

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 ARMapDTO atualizado.

Estrutura do objeto ARMapDTO

Nome do 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 de mapa em bytes.
gps String Informações de coordenadas GPS associadas ao mapa.
tag String Tag do mapa.
meta String Metadados personalizados.
md5 String Checksum MD5 do arquivo de mapa atualizado.
modified DateTime Hora da última modificação.

5. Códigos de status

Http Code Significado Observações
200 OK Requisição bem-sucedida.
201 Created Atualização bem-sucedida e registro relacionado criado.
401 Unauthorized Falha na autenticação. Verifique o Token ou a signature.
403 Forbidden Sem permissão para acessar este recurso.
404 Not Found O mapId especificado não foi encontrado.

Códigos de erro de Status Code

6. Resposta de exemplo (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
    "name": "updated_office_scene",
    "status": "active",
    "gps": "121.4541,31.2221",
    "modified": "2026-01-30T10:00:00Z"
  }
}