Table of Contents

API - meta データのダウンロードアドレスを取得する

このインターフェイスは、mapId を通じて、指定した Spatial Map に関連付けられた metadata(meta)のダウンロードリソース情報を取得するために使用します。

1. インターフェイス基本情報

  • インターフェイスアドレス: https://armap-api-<cn1,na1>.easyar.com/map/meta/{mapId}
  • リクエストメソッド: GET
  • レスポンス形式: */*(通常は application/json

2. 認証方式

このインターフェイスは、次の 2 つの認証モードをサポートします。

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

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

3.1 Path parameters

パラメータ名 必須 説明
mapId String はい 空間マップの一意識別子(MapId)。

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

リクエストが成功した場合(statusCode が 0)、返される result には metadata ファイルを指す Resource オブジェクトが含まれます。

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

Resource オブジェクト構造:

フィールド名 説明
filename String metadata ファイルのファイル名。
url Object (URL) protocol、host、path などの詳細なダウンロードアドレス情報を含むオブジェクト。
file Object (File) path、size など、ファイルの物理属性情報。
readable Boolean このリソースが読み取り可能かどうか。
open Boolean このリソースが現在開いている状態かどうか。

5. Status codes

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

Status Code エラーコード

6. レスポンス例 (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "filename": "map_metadata.json",
    "url": {
      "protocol": "https",
      "host": "armap-api-cn1.easyar.com",
      "path": "/download/path/to/meta",
      "query": "token=..."
    },
    "readable": true,
    "open": false
  }
}