---
title: "API"
slug: "arceye-api"
updated: 2026-09-17T09:23:32Z
published: 2026-09-17T09:23:32Z
canonical: "guide.ncloud-docs.com/arceye-api"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://guide.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API

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

APIでは ARロボットスマートビルなどに活用できる測位 APIをデプロイ、運用、管理する方法を説明します。

              参考

              

APIを使用すると課金が発生します。詳細は、[**ポータル > サービス > Digital Twin > ARC eye**](https://www.ncloud.com/product/digitalTwin/arcEye)をご参照ください。

## API画面

API画面は次のように構成されています。

![arceye-api_ko.png](https://cdn.document360.io/6998976f-9d95-4df8-b847-d375892b92c2/Images/Documentation/arceye-api_ko.png?sv=2026-02-06&spr=https&st=2026-10-26T14%3A31%3A40Z&se=2026-10-26T15%3A31%3A40Z&sr=c&sp=r&sig=g4zz%2F0OJ4PdyYhyhBkaRGXT7LN%2FuwCNhL806Vl68GwI%3D)

| エリア | 説明 |
| --- | --- |
| ① メニュー名 | 現在確認中のメニュー名 |
| ② 基本機能 | **API**メニューアクセス時に最初に表示される機能 - **[機能および料金のご案内]**: クリックすると、ARC eyeの紹介ページに移動 - **[更新]**: クリックすると、ページを更新 |
| ③ **プロジェクト名** | API管理を行う対象プロジェクトをドロップダウンリストから選択 |
| ④ **選択削除** | 選択したタスクデータを削除([APIの削除](/docs/ja/arceye-api#API%EC%82%AD%EC%A0%9C)を参照) |
| ⑤ **デプロイ** | APIをデプロイしてサービスを開始 |
| ⑥ **APIサービスの停止** | 運用中の APIサービスを停止 |
| ⑦ **API連携キーの確認** | APIの認証キーを作成し、Invoke URLを確認([API連携キー作成および Invoke URL確認](/docs/ja/arceye-api#API%EC%97%B0%EB%8F%99%ED%82%A4%EC%83%9D%EC%84%B1%EB%B0%8FInvokeURL%ED%99%95%EC%9D%B8)を参照) |
| ⑧ APIリスト | APIの状況確認、APIのデプロイ、停止、削除 - **区分**: APIタイプ区分(VLデータへの変換に成功すると自動作成) - **作成日時(UTC+09:00)** : APIデータを作成した日時 - **デプロイ日時(UTC+09:00)** : APIデータをデプロイした日時 - **APIバージョン**: APIサービスのバージョン - **データ**: APIデータを作成したソースデータ - **デプロイ状態**: APIサービスの状態 |

## APIサービスの運用

SLAMデータを VLデータに変換すると、画像認識値をリクエストできる APIデータを作成し、この APIデータをデプロイしてサービスを提供します。APIサービスを運用する方法は次の通りです。

              参考

              

APIの利用に関する詳細は、[ARC eye APIガイド](https://api.ncloud-docs.com/docs/ja/arc-eye-vl-api)をご参照ください。

1. NAVERクラウドプラットフォームコンソールで、**Menu** > **All Services** > **Digital Twin** > **ARC eye**メニューを順にクリックします。
2. **Visual Localizaiton > API** メニューを順にクリックします。
3. **プロジェクト名**のドロップダウンリストから希望するプロジェクトを選択します。
4. APIリストが表示されたら、必要に応じて次の操作を行います。
  - [API連携キー作成および Invoke URL確認](/docs/ja/arceye-api#API%EC%97%B0%EB%8F%99%ED%82%A4%EC%83%9D%EC%84%B1%EB%B0%8FInvokeURL%ED%99%95%EC%9D%B8)
  - [APIサービスの開始(デプロイ)](/docs/ja/arceye-api#API%EC%84%9C%EB%B9%84%EC%8A%A4%EC%8B%9C%EC%9E%91%EB%B0%B0%ED%8F%AC)
  - [APIサービスの停止](/docs/ja/arceye-api#API%EC%84%9C%EB%B9%84%EC%8A%A4%EC%A4%91%EC%A7%80)

### API連携キー作成および Invoke URL確認

APIサービスの使用権限を持つユーザーのみ APIにアクセスして APIを呼び出すように、先に API連携キー(secret key)を作成します。Invoke URLは、作成した APIデータを受けられるように呼び出すアドレス(endpoint)です。アプリ開発者などの APIユーザーは、`API連携キー + Invoke URL`を使用して APIを呼び出します。API連携キーを作成して確認する方法は次の通りです。

1. **[API連携キーを確認]** ボタンをクリックします。
2. API連携キー確認のポップアップで、**Secret Key**項目にある **[作成]** ボタンをクリックします。
  - 項目フィールドで API連携キーが作成されます。
  - 作成した API連携キーをクリップボードにコピーするには、**[コピー]** ボタンをクリックします。
3. **Invoke URL**で Invoke URLを確認します。
  - Invoke URLは、該当するプロジェクトを作成する際に自動作成されます。
  - Invoke URLをクリップボードにコピーするには、**[アドレスをコピー]** ボタンをクリックします。

### APIサービスの開始(デプロイ)

APIをデプロイするには、リストから APIをクリックして選択し、**[デプロイ]** ボタンをクリックします。

- 初デプロイの場合は、リストのデプロイ状態が**待機**から**完了**に変わり、**[APIサービスを停止]** ボタンが有効になります。
- 停止した APIを再デプロイする場合は、リストのデプロイ状態が**停止**から**完了**に変わり、**[APIサービスを停止]** ボタンが有効になります。
- 1つのプロジェクトにつき、1つの APIをデプロイできます。さまざまなバージョンの APIを持つプロジェクトで待機または停止状態の APIをデプロイすると、現在デプロイしている APIは自動的にサービスを停止します。

### APIサービスの停止

サービス提供中の APIを停止するには、リストから APIをクリックして選択し、**[APIサービスを停止]** ボタンをクリックします。

- APIサービスが停止すると、リストのデプロイ状態が**完了**から**停止**に変わり、**[デプロイ]** ボタンが有効になります。
- APIサービスを再デプロイするには、リストから APIを選択し、**[デプロイ]** ボタンをクリックします。

## APIの削除

APIを削除する方法は次の通りです。

              注意

              

APIを削除すると、その APIに登録したすべてのデータが削除され復旧できなくなり、連携中の他のタスクや利用中の APIサービスに問題が生じますので、慎重に行ってください。

              参考

              

デプロイ完了した APIは削除できません。まず、該当する APIに対して[APIサービスを停止](/docs/ja/arceye-api#API%EC%84%9C%EB%B9%84%EC%8A%A4%EC%A4%91%EC%A7%80)し、APIの削除を行ってください。

1. NAVERクラウドプラットフォームコンソールで、**Menu** > **All Services** > **Digital Twin** > **ARC eye**メニューを順にクリックします。
2. **Visual Localizaiton > API** メニューを順にクリックします。
3. **プロジェクト名**のドロップダウンリストから希望するプロジェクトを選択します。
4. 削除する APIが APIデプロイ中の場合は APIをクリックして選択し、**[APIサービスを停止]** ボタンをクリックして APIのデプロイを停止します。
5. 削除する APIをクリックして選択し、**[選択削除]** ボタンをクリックします。
6. API削除のポップアップが表示されたら、**[削除]** ボタンをクリックします。