API: Spatial Map マップリストを取得

この API は、現在の画像ライブラリ配下にあるすべての Spatial Map のリスト情報をページングで取得するために使用します。

1. API 基本情報

API アドレス: https://armap-api-<cn1,na1>.easyar.com/maps
リクエストメソッド: GET
レスポンス形式: */* (通常 application/json)

2. 認証方式

この API は次の 2 つの認証モードをサポートします。

Token ベース認証:
- Header: Authorization: [token]
- Parameter: AppId を付加する必要があります。
Signature ベース認証:
- APIKey、APISecret、AppId とパラメータを使用して signature を生成し、検証します。
- signature 計算の詳細なアルゴリズムについては、API Key 署名方法を参照してください。

3. リクエストパラメータ

3.1 クエリパラメータ (Query Parameters)

ページングパラメータは任意です。入力しない場合はデフォルト値が使用されます。

パラメータ名	型	必須	デフォルト値	説明
pageNum	Integer	いいえ	1	要求する対象ページ番号。
pageSize	Integer	いいえ	10	1 ページに表示するマップの最大数。

4. レスポンスデータ構造 (ResponseResult)

リクエストが成功した場合（statusCode が 0）、返される result にはマップリストとそのページングメタデータが含まれます。

フィールド名	型	説明
statusCode	Integer	ステータスコード。0 は成功を表します。
msg	String	ステータス説明情報。
timestamp	DateTime	サーバーレスポンスタイムスタンプ。
result	Object	マップデータ配列とページング統計情報を含む Map オブジェクト。

5. ステータスコード

Http Code	意味	説明
200	OK	リクエスト成功。
401	Unauthorized	認証失敗。Token または signature を確認してください。
403	Forbidden	このリソースにアクセスする権限がありません。
404	Not Found	関連リソースが見つかりません。

Status Code エラーコード

Sparse Spatial Map APIs ステータスコード説明

6. レスポンス例 (JSON)

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

Table of Contents