Table of Contents

Api —— metaデータのダウンロードアドレスを取得

このインターフェースは mapId を使用して、指定されたSpatial Map(空間マップ)に関連するメタデータ(meta)のダウンロードリソース情報を取得するために使用されます。

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

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

2. 認証方式

このインターフェースは以下の2つの認証モードをサポートします:

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

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

3.1 パスパラメータ (Path Parameters)

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

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

リクエストが成功した場合(statusCode が 0)、結果 result にはメタデータファイルを指す Resource オブジェクトが含まれます。

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

Resource オブジェクト構造:

フィールド名 タイプ 説明
filename String メタデータファイルのファイル名。
url Object (URL) プロトコル、ホスト、パスなどの詳細なダウンロードアドレス情報を含むオブジェクト。
file Object (File) ファイルの物理的属性情報(パス、サイズなど)。
readable Boolean リソースが読み取り可能かどうか。
open Boolean リソースが現在開かれているかどうか。

5. ステータスコード (Status Codes)

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

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