Table of Contents

API —— Mendapatkan daftar peta Spatial Map

Antarmuka ini digunakan untuk mendapatkan informasi daftar semua Spatial Map (peta ruang) di galeri saat ini secara halaman.

1. Informasi dasar antarmuka

  • Alamat antarmuka: https://armap-api-<cn1,na1>.easyar.com/maps
  • 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):
    • Gunakan APIKey, APISecret, AppId dan parameter untuk menghasilkan tanda tangan verifikasi.
    • Untuk algoritma perhitungan tanda tangan terperinci, lihat Metode tanda tangan API Key.

3. Parameter permintaan

3.1 Parameter kueri (Query Parameters)

Parameter halaman bersifat opsional, nilai default akan digunakan jika tidak diisi.

Nama parameter Tipe Wajib Nilai default Deskripsi
pageNum Integer Tidak 1 Halaman target yang diminta.
pageSize Integer Tidak 10 Jumlah maksimum peta per halaman.

4. Struktur data respons (ResponseResult)

Saat permintaan berhasil (statusCode 0), hasil result akan berisi daftar peta dan metadata halaman.

Nama kolom Tipe Deskripsi
statusCode Integer Kode status. 0 menunjukkan keberhasilan.
msg String Pesan deskripsi status.
timestamp DateTime Stempel waktu respons server.
result Object Objek Map yang berisi array data peta dan informasi statistik halaman.

5. Kode status

Http Code Arti Penjelasan
200 OK Permintaan berhasil.
401 Unauthorized Autentikasi gagal, periksa Token atau tanda tangan.
403 Forbidden Tidak memiliki akses ke sumber daya ini.
404 Not Found Sumber daya terkait tidak ditemukan.

Kode kesalahan status code

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
}