---
title: "API"
slug: "arceye-votapi"
updated: 2026-09-17T09:23:32Z
published: 2026-09-17T09:23:32Z
canonical: "guide.ncloud-docs.com/arceye-votapi"
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では作成したオブジェクトに関する Visual Object Tracking APIをデプロイ、運用、管理する方法を説明します。

              参考

              

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

## API画面

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

![arceye-votapi_01_ko](https://cdn.document360.io/6998976f-9d95-4df8-b847-d375892b92c2/Images/Documentation/arceye-votapi_01_ja.png?sv=2026-02-06&spr=https&st=2026-10-26T13%3A32%3A13Z&se=2026-10-26T14%3A32%3A13Z&sr=c&sp=r&sig=PGDi8aVCerCh89zrbPSHfFJD%2B7VQUJ%2Bafa%2Bux8QaCOg%3D)

| エリア | 説明 |
| --- | --- |
| ① メニュー名 | 現在確認中のメニューの名前 |
| ② 基本機能 | **API**メニューアクセス時に最初に表示される機能 - **[機能および料金のご案内]** : クリックすると、ARC eyeサービスの紹介ページに移動 - **[更新]** : クリックすると、ページを更新 |
| ③ プロジェクトの選択 | API管理を行う対象プロジェクトをドロップダウンリストから選択 |
| ④ タブメニュー | - APIリスト: APIデプロイ画面を表示 - デプロイ可能なオブジェクト: APIでサービスを提供するオブジェクトデプロイ画面を表示 |
| ⑤ 検索バー | オブジェクト名を入力して検索可能 |
| ⑥ **選択削除** | 選択したタスクデータを削除 |
| ⑦ **デプロイ** | APIをデプロイしてサービスを開始 |
| ⑧ **APIサービスの停止/API連携キーの確認** | - APIサービスの停止: 運用中 APIサービスを停止 - API連携キーの確認: API認証キー作成および Invoke URL確認([API連携キー作成および Invoke URL確認](/docs/ja/arceye-votapi#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データの初作成が完了し、APIデプロイ前の状態 - **完了**: APIをデプロイしてサービス提供中の状態 - **停止**: APIサービスを停止した状態 |

## オブジェクトのデプロイ

APIでデプロイするオブジェクトを選択してデプロイします。オブジェクトは最大20つまで一気にデプロイでき、オブジェクトをデプロイすると前のバージョンの APIデプロイは停止されます。オブジェクトを選択してデプロイした後は、**[APIリスト]** タブメニューに移動して APIをデプロイします。オブジェクトをデプロイする方法は、次の通りです。

1. NAVERクラウドプラットフォームコンソールで、**Menu** > **All Services** > **Digital Twin** > **ARC eye**メニューを順にクリックします。
2. **Visual Object Tracking > API** メニューを順にクリックします。
3. **プロジェクト名**のドロップダウンリストから希望するプロジェクトを選択します。
4. **[デプロイ可能なオブジェクト]** タブメニューをクリックします。
5. オブジェクトリストが表示されたら、デプロイするオブジェクトをクリックして選択し、**[デプロイ]** ボタンをクリックします。

## オブジェクトの削除

デプロイ可能なオブジェクトリストでオブジェクトを削除する方法は、次の通りです。

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

## APIサービスの運用

タグ付けをしてオブジェクトを作成すると APIが作成され、この APIをデプロイしてサービスを提供できます。APIサービスを運用する方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールで、**Menu** > **All Services** > **Digital Twin** > **ARC eye**メニューを順にクリックします。
2. **Visual Object Tracking > API** メニューを順にクリックします。
3. **プロジェクト名**のドロップダウンリストから希望するプロジェクトを選択します。
4. **[APIリスト]** タブメニューをクリックします。
5. APIリストが表示されたら、必要に応じて次の操作を行います。
  - [API連携キー作成および Invoke URL確認](/docs/ja/arceye-votapi#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-votapi#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-votapi#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-votapi#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 Object Tracking > API** メニューを順にクリックします。
3. **プロジェクト名**のドロップダウンリストから希望するプロジェクトを選択します。
4. **[APIリスト]** タブメニューをクリックします。
5. 削除する APIが APIデプロイ中の場合は APIをクリックして選択し、**[APIサービスを停止]** ボタンをクリックして APIのデプロイを停止します。
6. 削除する APIをクリックして選択し、**[選択削除]** ボタンをクリックします。
7. API削除のポップアップが表示されたら、**[削除]** ボタンをクリックします。