Sparse Spatial Map 管理 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 認証または signature 認証のいずれかを選択）
Spatial Map API パラメータ: API 独自のパラメータ

API ドキュメントでは、認証に使用する公開パラメータはこれ以上説明しません

API Key 認証

認証方式は 2 つあります。

Token ベース認証

HTTP ヘッダー Authorization には Token が含まれ、公開パラメータには次が含まれます:

appId

署名認証

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

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

appId
timestamp
apiKey
signature

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

使用例とプロパティの説明

API 使用例

以下の例では、API 呼び出しで Spatial Map データを照会し、開発者が 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
}

Sparse map のプロパティ

上の例に示すように、これは通常返される Spatial Map 構造です

プロパティ	説明
mapId	一意なマップ ID
name	マップ名
size	マップファイルのサイズ
meta	ユーザー関連データ。ファイル、テキスト、URL にでき、base64 エンコードが必要です
status	無効化されているかどうか。値は [active inactive]
tag	検索しやすくするためのカスタムタグ
floor	検索しやすくするためのフロア
gps	空間の地理的位置、wgs84 座標系、または独自定義の座標系
previewUrl	プレビュー画像のダウンロード

エラーコード

Sparse Spatial Map APIs のエラーコード説明

Table of Contents