ARC eyeの概要

Prev Next

Classic/VPC環境で利用できます。

ARC eyeは、AR・ロボット・スマートビルディングなどさまざまな分野で活用できる測位および物体追跡をサポートする NAVERクラウドプラットフォームのデジタルツイン環境構築サービスです。ARC eyeサービスでは、空間測位(VL、Visual Localization)と物体追跡(VOT、Visual Object Tracking)を行う APIを RESTful形式で提供します。

ARC eyeの共通設定

ARC eye APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

API API URL 確認方法
VL NAVERクラウドプラットフォームコンソールの ARC eye > Visual Localization > APIメニューで [API連携キーを確認] ボタンをクリックすると表示される Invoke URL API連携キーの作成と Invoke URLの確認
VOT NAVERクラウドプラットフォームコンソールの ARC eye > Visual Object Tracking > APIメニューで [API連携キーを確認] ボタンをクリックすると表示される Invoke URL API連携キーの作成と Invoke URLの確認

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
X-ARCEYE-SECRET Required ARC eyeサービスから発行された Secret Key
  • VL: NAVERクラウドプラットフォームコンソールの ARC eye > Visual Localization > APIメニューで [API連携キーを確認] ボタンと Secret Keyの [作成] ボタンを順にクリック
  • VOT: NAVERクラウドプラットフォームコンソールの ARC eye > Visual Object Tracking > APIメニューで [API連携キーを確認] ボタンと Secret Keyの [作成] ボタンを順にクリック
Content-Type Required リクエストデータの形式
  • multipart/form-data

レスポンス

共通レスポンス形式を説明します。

レスポンスボディ

呼び出しが成功した場合のレスポンスボディは、API仕様書を確認してください。呼び出しが失敗した場合のレスポンスボディは次の通りです。

フィールド タイプ 必須の有無 説明
code String - エラーコード
message String - エラーメッセージ
path String - エラー発生パス
product String - エラーサービス名
traceId String - エラートレース ID
timestamp Long - エラー発生日時(ミリ秒)
  • Unix Timestamp形式
status Number - レスポンスステータスコード
details String - エラーメッセージの詳細説明
errors String - エラーデータセット情報
  • Visual Localization専用
errors.datasetInfo String - スキャン時に区分した各階層の名前を1つに繋げた値
errors.datasetInfoScore String - ロケーション区分の精度
  • 0に近いほど信頼度が低く、1に近いほど信頼度が高い

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

Visual Localization
Visual Localization関連のレスポンスステータスコードは次の通りです。

HTTPステータスコード コード メッセージ 説明
400 0100 there is no location locationパラメータが入力されていない
400 0100 failed to parse wifi scan file 入力された WiFiスキャンデータに誤りがある
40x 0100 Invalid Parameter 無効なリクエストパラメータ
401 0020 Unauthorized 無効な認証情報
403 0030 Forbidden アクセス権限なしのリクエスト
404 0001 Not Found 存在しないリソース
404 0100 failed to get location info from qdrant: xxx Qdrant DBから location情報を得られない
404 0100 failed to get wifi-finder model file from S3 加工された WiFi Finderモデルがない
404 0100 wifi-loc model does not exists 加工された WiFi Locモデルがない
409 0101 Duplicate 重複したリクエストまたはリソース
422 0100 failed, it has low dataset info score 対象のロケーションに有効な WiFi電波がない場合
422 0100 failed to get location info from qdrant: xxx 低い DatasetInfoScoreにより、ロケーション識別が困難
500 1000 No matching AP list exists mac-addressが一致する WiFi電波がない
500 1000 failed to load qdrant Qdrant vector DBと通信ができない
500 1000 failed to get global position filefrom qdrant Qdrantから global position情報を得られない
500 1000 out of service, due to there is no valid xxx リソースがないため、内部サーバ間通信にエラー発生
50x 1000 Internal API Error サーバ内部エラー
500 1001 Processing Error リクエスト処理中にエラー発生
500 9999 Unknown Error 不明なサーバエラー

Visual Object Tracking
Visual Object Tracking関連のレスポンスステータスコードは次の通りです。

HTTPステータスコード コード メッセージ 説明
404 0001 Not Found 存在しないリソース
401 0020 Unauthorized 無効な認証情報
403 0030 Forbidden アクセス権限なしのリクエスト
40x 0100 Invalid Parameter 無効なリクエストパラメータ
409 0101 Duplicate 重複したリクエストまたはリソース
50x 1000 Internal API Error サーバ内部エラー
500 1001 Processing Error リクエスト処理中にエラー発生
500 9999 Unknown Error 不明なサーバエラー

レスポンス例

呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

  • VL API、VOT APIの呼び出しに失敗

    {
  "code": "9999",
  "message": "Unknown server error.",
  "path": "/api/v1",
  "product": "ARC eye",
  "traceId": "9c1f55ac7d8341d792a922b2590c045f",
  "timestamp": 1570776853475,
  "status": "500"
}

  • VL(WiFi Localization) APIの呼び出しに失敗

    {
  "traceId": "3d77c10b1a0646659b6c897a35a5fa64",
  "path": "/vl/v1/300568/9bb1a2b6f8031e355dfdb8e5205a1f7a860b167a0fcbd35681235f35c3629634/location",
  "timestamp": 1725449250446,
  "product": "ARC eye",
  "status": 422,
  "code": "0100",
  "message": "Invalid parameters.",
  "details": "there are no valid signals",
  "errors": { // optional
    "datasetInfo": "Naver_1784_1F",
    "datasetInfoScore": 0.6852494
  }
}

ARC eye API

ARC eyeサービスが提供する APIの説明は次の通りです。

API 説明
Visual Localization 測位情報を照会
Visual Object Tracking 物体の姿勢推定結果を照会

ARC eye関連リソース

ARC eye APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。