Table of Contents

API —— Atualizar informações do mapa Spatial Map

Esta interface atualiza as informações do mapa através do mapId especificado. Suporta uma atualização semelhante ao HTTP PATCH, ou seja, apenas os parâmetros fornecidos na solicitação são modificados, e os parâmetros não fornecidos permanecerão inalterados.

1. Informações básicas da interface

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

2. Método de autenticação

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

  1. Autenticação baseada em Token:
    • Header: Authorization: [token]
    • Parâmetro: É necessário 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 da 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).

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

Devido ao formato multipart/form-data, os seguintes parâmetros devem ser enviados através de 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 (ex: "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 da lista de bloqueio EME, padrão é "[]".

4. Estrutura de dados da resposta (ARMapDTO)

Quando a solicitação é bem-sucedida (statusCode 0), o resultado result conterá os detalhes do objeto mapa atualizado.

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 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 do mapa (em bytes).
gps String Informações de coordenadas GPS associadas ao mapa.
tag String Tag do mapa.
meta String Metadados personalizados.
md5 String Código de verificação MD5 do arquivo de mapa após a atualização.
modified DateTime Data/hora da última modificação.

5. Códigos de status (Status Codes)

Código HTTP Significado Descrição
200 OK Solicitação bem-sucedida.
201 Created Atualização bem-sucedida e registros relacionados criados.
401 Unauthorized Falha na autenticação, verifique o Token ou a assinatura.
403 Forbidden Sem permissão para acessar este recurso.
404 Not Found mapId especificado não encontrado.

Códigos de erro Status Code

6. Exemplo de resposta (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"
  }
}