API

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

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

参考

APIを使用すると課金が発生します。詳細は、ポータル > サービス > Digital Twin > ARC eyeをご参照ください。

API画面

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

エリア	説明
① メニュー名	現在確認中のメニュー名
② 基本機能	APIメニューアクセス時に最初に表示される機能 [機能および料金のご案内]: クリックすると、ARC eyeの紹介ページに移動 [更新]: クリックすると、ページを更新
③ プロジェクト名	API管理を行う対象プロジェクトをドロップダウンリストから選択
④ 選択削除	選択したタスクデータを削除(APIの削除を参照)
⑤ デプロイ	APIをデプロイしてサービスを開始
⑥ APIサービスの停止	運用中の APIサービスを停止
⑦ API連携キーの確認	APIの認証キーを作成し、Invoke URLを確認(API連携キー作成および Invoke URL確認を参照)
⑧ APIリスト	APIの状況確認、APIのデプロイ、停止、削除区分: APIタイプ区分(VLデータへの変換に成功すると自動作成) 作成日時(UTC+09:00) : APIデータを作成した日時デプロイ日時(UTC+09:00) : APIデータをデプロイした日時 APIバージョン: APIサービスのバージョンデータ: APIデータを作成したソースデータデプロイ状態: APIサービスの状態待機: APIデータの初作成が完了し、APIデプロイ前の状態完了: APIをデプロイしてサービス提供中の状態停止: APIサービスを停止した状態

APIサービスの運用

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

参考

APIの利用に関する詳細は、ARC eye APIガイドをご参照ください。

NAVERクラウドプラットフォームコンソールで、 > Services > Digital Twin > ARC eyeメニューを順にクリックします。
Visual Localizaiton > API メニューを順にクリックします。
プロジェクト名のドロップダウンリストから希望するプロジェクトを選択します。
APIリストが表示されたら、必要に応じて次の操作を行います。

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

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

[API連携キーを確認] ボタンをクリックします。
API連携キー確認のポップアップで、Secret Key項目にある [作成] ボタンをクリックします。
- 項目フィールドで API連携キーが作成されます。
- 作成した API連携キーをクリップボードにコピーするには、[コピー] ボタンをクリックします。
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サービスを停止し、APIの削除を行ってください。

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