Table of Contents

API - Mendapatkan alamat unduhan data meta

Interface ini digunakan untuk mendapatkan informasi resource unduhan metadata (meta) yang terkait dengan Spatial Map tertentu melalui mapId.

1. Informasi dasar interface

  • Alamat interface: https://armap-api-<cn1,na1>.easyar.com/map/meta/{mapId}
  • 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, dan AppId untuk membuat signature guna verifikasi.
    • Untuk algoritma detail perhitungan signature, lihat metode signature API Key.

3. Parameter request

3.1 Path parameters

Nama parameter Tipe Wajib Deskripsi
mapId String Ya Identifier unik spatial map (MapId).

4. Struktur data response (Resource)

Saat request berhasil (statusCode adalah 0), result yang dikembalikan berisi objek Resource yang mengarah ke file metadata.

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

Struktur objek Resource:

Nama field Tipe Deskripsi
filename String Nama file metadata.
url Object (URL) Objek yang berisi informasi detail alamat unduhan seperti protocol, host, dan path.
file Object (File) Informasi properti fisik file, seperti path dan size.
readable Boolean Apakah resource ini dapat dibaca.
open Boolean Apakah resource ini sedang dalam status terbuka.

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.
404 Not Found Map atau metadata yang ditentukan tidak ditemukan.

Kode error Status Code

6. Contoh response (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "filename": "map_metadata.json",
    "url": {
      "protocol": "https",
      "host": "armap-api-cn1.easyar.com",
      "path": "/download/path/to/meta",
      "query": "token=..."
    },
    "readable": true,
    "open": false
  }
}