API: Mendapatkan daftar Spatial Map

API ini digunakan untuk mendapatkan informasi daftar semua Spatial Map di bawah pustaka gambar saat ini secara paginasi.

1. Informasi dasar API

Alamat API: https://armap-api-<cn1,na1>.easyar.com/maps
Metode request: GET
Format respons: */* (biasanya application/json)

2. Autentikasi

API ini mendukung dua mode autentikasi berikut:

Autentikasi berbasis Token:
- Header: Authorization: [token]
- Parameter: AppId harus disertakan.
Autentikasi berbasis Signature:
- Gunakan APIKey, APISecret, AppId, dan parameter untuk membuat signature guna verifikasi.
- Untuk algoritme detail perhitungan signature, lihat metode signature API Key.

3. Parameter request

3.1 Parameter query (Query Parameters)

Parameter paginasi bersifat opsional. Jika tidak diisi, nilai default akan digunakan.

Nama parameter	Tipe	Wajib	Default	Deskripsi
pageNum	Integer	Tidak	1	Nomor halaman target yang diminta.
pageSize	Integer	Tidak	10	Jumlah peta maksimum yang ditampilkan per halaman.

4. Struktur data respons (ResponseResult)

Ketika request berhasil (statusCode bernilai 0), result yang dikembalikan berisi daftar peta dan metadata paginasinya.

Nama field	Tipe	Deskripsi
statusCode	Integer	Kode status. 0 berarti berhasil.
msg	String	Informasi deskripsi status.
timestamp	DateTime	Timestamp respons server.
result	Object	Objek Map yang berisi array data peta dan statistik paginasi.

5. Kode status

Http Code	Arti	Keterangan
200	OK	Request berhasil.
401	Unauthorized	Autentikasi gagal. Periksa Token atau signature.
403	Forbidden	Tidak berhak mengakses resource ini.
404	Not Found	Resource terkait tidak ditemukan.

Kode error Status Code

Deskripsi kode status Sparse Spatial Map APIs

6. Contoh respons (JSON)

{
  "result": {
    "armaps": [
      {
        "mapId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "gps": "[0.0, 0.0]",
        "name": "Map_2020-09-28_1302",
        "size": 124140,
        "status": "active",
        "auxiliaryId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "created": 1601245841687,
        "modified": 1601245841687,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "appKey": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9f.."
      },
      {
        "mapId": "5ccdf1fb-0cd3-4580-80aa-42bd2289...",
        "gps": "[0.0, 0.0]",
        "name": "test",
        "size": 2419184,
        "status": "active",
        "auxiliaryId": "5ccdf1fb-0cd3-4580-80aa-42bd22897b...",
        "floor": "1",
        "tag": "cat",
        "created": 1601244090670,
        "modified": 1601244090670,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley....",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...."
      }
    ],
    "page": {
      "total": 2,
      "pageNum": 1,
      "pageSize": 10,
      "pages": 1
    }
  },
  "statusCode": 0,
  "msg": "Success",
  "timestamp": 1769406021019
}

Table of Contents