Table of Contents

API - Mencari peta Spatial Map

Interface ini digunakan untuk mencari peta Spatial Map. Semua parameter pencarian bersifat opsional. Saat beberapa field digunakan untuk pencarian, sistem akan menghubungkan setiap kondisi dengan logika "AND".

1. Informasi dasar interface

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

2. Metode autentikasi

Interface ini mendukung dua mode autentikasi berikut:

  1. Autentikasi berbasis Token:
    • Header: Authorization: [token]
    • Parameter: Harus menyertakan AppId.
  2. Autentikasi berbasis signature:
    • Gunakan APIKey, APISecret, AppId, dan parameter untuk membuat signature guna verifikasi.
    • Untuk algoritma detail perhitungan signature, lihat metode signature API Key.

3. Parameter request

3.1 Query parameters

Semua parameter pencarian bersifat opsional.

Nama parameter Tipe Wajib Nilai default Deskripsi
gps String Tidak - Mencari map di sekitar koordinat GPS ini.
range Number Tidak 1.0 Rentang pencarian (unit: km). Harus digunakan bersama parameter gps.
name String Tidak - Mencari berdasarkan nama map.
tag String Tidak - Mencari berdasarkan tag map.

4. Struktur data response (ARMapDTO)

Saat request berhasil (statusCode adalah 0), result yang dikembalikan berisi array objek map yang memenuhi kondisi.

Nama field Tipe Deskripsi
statusCode Integer Kode status. 0 berarti berhasil.
msg String Informasi deskripsi status.
timestamp DateTime Timestamp response server.
result Array Array yang berisi objek ARMapDTO.

Struktur objek ARMapDTO

Nama field Tipe Deskripsi
mapId String Identifier unik map.
name String Nama map.
status String Status map saat ini.
size Integer (int64) Ukuran file map.
gps String Informasi koordinat GPS yang terkait dengan map.
tag String Tag map.
meta String Metadata kustom.
created DateTime Waktu pembuatan.
modified DateTime Waktu modifikasi terakhir.

5. Status codes

Http Code Arti Deskripsi
200 OK Request berhasil.
401 Unauthorized Autentikasi gagal. Periksa Token atau signature.
403 Forbidden Tidak memiliki izin untuk mengakses resource ini.

Kode error Status Code

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