Table of Contents

API —— memperbarui informasi peta Spatial Map

Antarmuka ini memperbarui informasi peta melalui mapId yang ditentukan. Mendukung metode pembaruan mirip HTTP PATCH, yaitu hanya memodifikasi parameter yang disediakan dalam permintaan, parameter yang tidak disediakan akan tetap tidak berubah.

1. Informasi dasar antarmuka

  • Alamat antarmuka: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • Metode permintaan: PUT
  • Format permintaan: multipart/form-data
  • Format respons: */* (biasanya application/json)

2. Metode autentikasi

Antarmuka ini mendukung dua mode autentikasi berikut:

  1. Autentikasi berbasis Token:
    • Header: Authorization: [token]
    • Parameter: Harus menyertakan AppId.
  2. Autentikasi berbasis tanda tangan (Signature):
    • Menggunakan APIKey, APISecret, dan AppId serta parameter untuk menghasilkan tanda tangan untuk verifikasi.
    • Untuk algoritma perhitungan tanda tangan yang rinci, lihat Metode tanda tangan API Key.

3. Parameter permintaan

3.1 Parameter jalur (Path Parameters)

Nama parameter Tipe Wajib Deskripsi
mapId String Ya Pengidentifikasi unik peta spasial (MapId).

3.2 Parameter formulir (Form Parameters)

Karena menggunakan format multipart/form-data, parameter berikut harus dikirimkan melalui kolom formulir.

Nama parameter Tipe Wajib Deskripsi
file File Tidak File data peta baru.
name String Tidak Nama tampilan peta.
gps String Tidak Koordinat GPS yang terkait dengan peta (misalnya: "121.4541,31.2221").
tag String Tidak Tag peta.
meta String Tidak Metadata kustom (biasanya string yang dikodekan Base64).
clusterInfo String Tidak Informasi terkait klaster.
emeBlocklist String Tidak Konfigurasi daftar hitam EME, defaultnya adalah "[]".

4. Struktur data respons (ARMapDTO)

Saat permintaan berhasil (statusCode adalah 0), hasil result akan berisi detail objek peta yang diperbarui.

Nama bidang Tipe Deskripsi
statusCode Integer Kode status. 0 menandakan sukses.
msg String Pesan deskripsi status.
timestamp DateTime Stempel waktu respons server.
result Object Objek ARMapDTO yang diperbarui.

Struktur objek ARMapDTO

Nama bidang Tipe Deskripsi
mapId String Pengidentifikasi unik peta.
name String Nama peta.
status String Status peta saat ini.
size Integer (int64) Ukuran file peta (dalam byte).
gps String Informasi koordinat GPS yang terkait dengan peta.
tag String Tag peta.
meta String Metadata kustom.
md5 String Kode pemeriksaan MD5 file peta yang diperbarui.
modified DateTime Waktu modifikasi terakhir.

5. Kode status (Status Codes)

Kode Http Arti Penjelasan
200 OK Permintaan berhasil.
201 Created Pembaruan berhasil dan catatan terkait telah dibuat.
401 Unauthorized Autentikasi gagal, harap periksa Token atau tanda tangan.
403 Forbidden Tidak memiliki izin untuk mengakses sumber daya ini.
404 Not Found mapId yang ditentukan tidak ditemukan.

Penjelasan kode kesalahan Status Code

6. Contoh respons (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"
  }
}