Table of Contents

Pengantar APIs manajemen Sparse Spatial Map

Ikhtisar API

Protokol REST API dan mekanisme authentication

Spatial Map API mengikuti spesifikasi transport HTTP REST standar.

Http Header

    Authorization:

HTTP request parameters dibagi menjadi dua jenis:

  • Public parameters (semuanya termasuk; digunakan berbeda tergantung authentication method):

    • appId
    • timestamp (Long integer: milidetik yang telah berlalu sejak 00:00:00 UTC pada 1 Januari 1970)
    • apiKey
    • signature (request signature, pilih salah satu token authentication atau signature authentication)

  • Spatial Map API parameters: parameter milik API sendiri

    Dokumentasi API tidak lagi mendeskripsikan public parameters yang digunakan untuk authentication

API Key authentication

Ada dua authentication methods.

Token-based authentication

Http header Authorization berisi Token, dan public parameters mencakup:

  • appId

Signature authentication

Jangan gunakan Http header Authorization.

Request parameters berisi informasi signature. Semua parameters dihitung dalam signature calculation (kecuali image).

  • appId
  • timestamp
  • apiKey
  • signature

Untuk algoritma detail signature calculation, silakan lihat metode signature API Key.

Contoh penggunaan dan interpretasi properti

Contoh penggunaan API

Contoh berikut menggunakan API call untuk query data Spatial Map agar membantu developer memahami Spatial Map API dan struktur spatial map.

Contoh request

  GET /maps HTTP/1.1
  Host:
  Date: Mon, 1 Jan 2018 00:00:00 GMT
  Content-Type: application/json
  {
      "timestamp": 1769406019000,
      "apiKey": "8b485c648c3056e79c2a85ee9b...",
      "appId": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9..",
      "signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
  }

Contoh response

 {
  "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
}

Properti sparse map

Seperti terlihat pada contoh di atas, ini adalah struktur Spatial Map yang dikembalikan secara normal

Property Description
mapId ID unik map
name Nama map
size Ukuran file map
meta Data yang terkait dengan user, bisa berupa file, text, atau url, dan perlu di-encode base64
status Apakah dinonaktifkan, nilainya [active inactive]
tag Custom tag agar mudah dicari
floor Lantai agar mudah dicari
gps Lokasi geografis ruang, coordinate system wgs84, atau coordinate system buatan sendiri
previewUrl Download preview image

Error codes

Topik terkait