スパース空間マップ管理 APIs の概要

API 一覧

REST API インターフェースプロトコルと認証メカニズム

Spatial Map API は標準 HTTP REST 伝送規格に準拠します。

Http ヘッダー

Authorization: <APIKey で取得した Token を入力>

Http リクエストパラメータは2種類に分類されます:

共通パラメータ (認証方式に応じて以下の組み合わせで使用):
- appId
- timestamp（Long 長整数型: 1970年1月1日00:00:00 UTC からの経過ミリ秒）
- apiKey
- signature（リクエスト署名、token 認証と二者択一）
Spatial Map API パラメータ: API 固有のパラメータ

API ドキュメントでは認証用共通パラメータは記述しません

API Key 認証

認証方式は2種類あります。

Token ベース認証

Http ヘッダー Authorization に Token を含め、共通パラメータは以下:

appId

署名認証

Http ヘッダー Authorization は使用しません。

リクエストパラメータに signature 署名情報を含めます。全てのパラメータが署名計算に含まれます（画像を除く）。

appId
timestamp
apiKey
signature

署名計算の詳細なアルゴリズムについては、ドキュメント API Key 署名方法を参照してください。

使用例と属性解析

API 使用例

Spatial Map マップデータを照会する API インターフェース呼び出しの例を通じて、Spatial Map API インターフェースと空間マップ構造について説明します。

リクエスト例

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

レスポンス例

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

スパースマップ属性

上記の例に示すように、これは正常に返される Spatial Map 空間マップ構造体です

属性	説明
mapId	マップの一意な ID
name	マップ名
size	マップファイルサイズ
meta	ユーザー関連データ（ファイル/テキスト/URL）、base64 エンコードが必要
status	無効化状態、値は [active inactive]
tag	検索用カスタムタグ
floor	検索用フロア情報
gps	空間の地理的位置（WGS84座標系または独自座標系）
previewUrl	プレビュー画像ダウンロード URL

エラーコード

スパース空間マップ APIs エラーコード説明

Table of Contents