API

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

APIでは作成したオブジェクトに関する Visual Object Tracking APIをデプロイ、運用、管理する方法を説明します。

API画面

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

オブジェクトのデプロイ

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

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

オブジェクトの削除

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

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

APIサービスの運用

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

1. NAVERクラウドプラットフォームコンソールで、 > Services > Digital Twin > ARC eyeメニューを順にクリックします。
2. Visual Object Tracking > API メニューを順にクリックします。
3. プロジェクト名のドロップダウンリストから希望するプロジェクトを選択します。
4. [APIリスト] タブメニューをクリックします。
5. APIリストが表示されたら、必要に応じて次の操作を行います。
   • API連携キー作成および Invoke URL確認
   • APIサービスの開始(デプロイ)
   • APIサービスの停止

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を削除する方法は次の通りです。

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