Table of Contents

API —— pencarian peta Spatial Map

Antarmuka ini digunakan untuk mencari Spatial Map (peta spasial). Semua parameter pencarian bersifat opsional. Saat menggunakan beberapa bidang untuk pencarian, sistem akan menghubungkan setiap kondisi dengan logika "AND".

1. Informasi dasar antarmuka

  • Alamat antarmuka: https://armap-api-<cn1,na1>.easyar.com/map
  • Metode permintaan: GET
  • Format respons: */* (biasanya application/json)

2. Metode autentikasi

Antarmuka ini mendukung dua mode otorisasi berikut:

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

3. Parameter permintaan

3.1 Parameter kueri (Query Parameters)

Semua parameter pencarian bersifat opsional.

Nama parameter Tipe Wajib Nilai default Deskripsi
gps String Tidak - Cari peta di sekitar koordinat GPS ini.
range Angka Tidak 1.0 Rentang pencarian (satuan: km). Harus digunakan dengan parameter gps.
name String Tidak - Cari berdasarkan nama peta.
tag String Tidak - Cari berdasarkan tag peta.

4. Struktur data respons (ARMapDTO)

Saat permintaan berhasil (statusCode adalah 0), hasil result akan berisi array objek peta yang memenuhi syarat.

Nama bidang Tipe Deskripsi
statusCode Integer Kode status. 0 menunjukkan sukses.
msg String Pesan deskripsi status.
timestamp DateTime Stempel waktu respons server.
result Array Berisi array objek ARMapDTO.

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.
gps String Informasi koordinat GPS yang terkait dengan peta.
tag String Tag peta.
meta String Metadata khusus.
created DateTime Waktu pembuatan.
modified DateTime Waktu modifikasi terakhir.

5. Kode status (Status Codes)

Kode Http Arti Penjelasan
200 OK Permintaan berhasil.
401 Unauthorized Autentikasi gagal, harap periksa Token atau tanda tangan.
403 Forbidden Tidak memiliki izin untuk mengakses sumber daya ini.

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": "office_scene",
      "status": "active",
      "gps": "121.4541,31.2221",
      "tag": "indoor"
    }
  ]
}