Table of Contents

Pengantar Api manajemen peta ruang renggang

Api lengkap

Protokol antarmuka Rest Api dan mekanisme otentikasi

Spatial Map Api mengikuti standar transmisi Http Rest standar.

Http Header

    Authorization:

Parameter permintaan Http, dibagi menjadi dua jenis:

  • Parameter publik (termasuk ini, metode otentikasi yang berbeda menggunakan kombinasi yang berbeda):

    • appId
    • timestamp (Long integer: milidetik yang telah berlalu sejak 1 Januari 1970 00:00:00 UTC)
    • apiKey
    • signature (tanda tangan permintaan, pilih satu dari dua metode otentikasi token)

  • Parameter Spatial Map Api: parameter Api itu sendiri

    Dokumentasi Api tidak lagi menjelaskan parameter publik untuk otentikasi

Otentikasi Api Key

Metode otentikasi dibagi menjadi dua jenis.

Otentikasi berbasis Token

Header Http Authorization berisi Token, parameter publik termasuk:

  • appId

Otentikasi tanda tangan

Tidak menggunakan header Http Authorization.

Parameter permintaan berisi informasi tanda tangan signature. Semua parameter dimasukkan dalam perhitungan tanda tangan (kecuali gambar).

  • appId
  • timestamp
  • apiKey
  • signature

Untuk algoritma rinci perhitungan tanda tangan, silakan merujuk ke dokumen Metode tanda tangan Api Key.

Contoh penggunaan dan analisis properti

Contoh penggunaan Api

Di sini melalui contoh - memanggil antarmuka Api untuk mengkueri data peta Spatial Map, membantu pengembang memahami antarmuka Api Spatial Map dan struktur peta ruang.

Contoh permintaan

  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 respons

 {
  "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 peta renggang

Seperti yang ditunjukkan dalam contoh di atas, ini adalah struktur peta ruang Spatial Map yang dikembalikan dengan normal

Properti Deskripsi
mapId Id unik peta
name Nama peta
size Ukuran file peta
meta Data terkait pengguna, dapat berupa file, teks atau url, perlu dikodekan base64
status Apakah dinonaktifkan, dua nilai [active inactive]
tag Tag kustom, untuk memudahkan pencarian
floor Lantai, untuk memudahkan pencarian
gps Lokasi geografis ruang, sistem koordinat wgs84, atau dapat menggunakan sistem koordinat yang ditentukan sendiri
previewUrl Unduh gambar pratinjau

Kode kesalahan

Topik terkait