API —— Mendapatkan URL unduh data meta
Antarmuka ini digunakan untuk mendapatkan informasi sumber daya unduh metadata (meta) yang terkait dengan Spatial Map (peta spasial) tertentu melalui mapId.
1. Informasi dasar antarmuka
- Alamat antarmuka:
https://armap-api-<cn1,na1>.easyar.com/map/meta/{mapId} - Metode permintaan:
GET - Format respons:
*/*(biasanyaapplication/json)
2. Metode autentikasi
Antarmuka ini mendukung dua mode autentikasi berikut:
- Autentikasi berbasis Token:
- Header:
Authorization: [token] - Parameter: Harus menyertakan
AppId.
- Header:
- Autentikasi berbasis tanda tangan (Signature):
- Gunakan
APIKey,APISecret, danAppIduntuk menghasilkan tanda tangan untuk verifikasi. - Algoritme perhitungan tanda tangan yang rinci, lihat Metode tanda tangan API Key.
- Gunakan
3. Parameter permintaan
3.1 Parameter jalur (Path Parameters)
| Nama parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| mapId | String | Ya | Pengidentifikasi unik peta spasial (MapId). |
4. Struktur data respons (Resource)
Saat permintaan berhasil (statusCode 0), hasil result akan berisi objek Resource yang menunjuk ke file metadata.
| Nama bidang | Tipe | Deskripsi |
|---|---|---|
| statusCode | Integer | Kode status. 0 menunjukkan keberhasilan. |
| msg | String | Pesan deskripsi status. |
| timestamp | DateTime | Stempel waktu respons server. |
| result | Object | Berisi objek Map yang memuat array data peta dan informasi statistik paginasi. |
Struktur objek Resource:
| Nama bidang | Tipe | Deskripsi |
|---|---|---|
| filename | String | Nama file metadata. |
| url | Object (URL) | Objek yang berisi informasi alamat unduh rinci seperti protokol, host, jalur, dll. |
| file | Object (File) | Informasi atribut fisik file (seperti jalur, ukuran, dll). |
| readable | Boolean | Apakah sumber daya ini dapat dibaca. |
| open | Boolean | Apakah sumber daya ini saat ini dalam keadaan terbuka. |
5. Kode status (Status Codes)
| Kode Http | Arti | Penjelasan |
|---|---|---|
| 200 | OK | Permintaan berhasil. |
| 401 | Unauthorized | Autentikasi gagal, periksa Token atau tanda tangan. |
| 403 | Forbidden | Tidak memiliki izin untuk mengakses sumber daya ini. |
| 404 | Not Found | Peta atau metadata yang ditentukan tidak ditemukan. |
Kode kesalahan Status Code
6. Contoh respons (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
}
}