API

Available in Classic and VPC

The API guide describes how to deploy, operate, and manage Visual Object Tracking APIs for the object created.

API page

The API page is laid out as follows:

Deploy object

Select the object you want to deploy through APIs and deploy the object. You can deploy up to 20 objects at once. When you deploy objects, deploying the previous version of API is stopped. After you select and deploy objects, go to the [API list] tab menu to deploy APIs. To deploy objects:

1. Navigate to > Services > Digital Twin > ARC eye in the NAVER Cloud Platform console.
2. Navigate to Visual Object Tracking > API .
3. Select a project you want from the Project name dropdown list.
4. Click the [Deployable object] tab menu.
5. Once the object list is displayed, click the object to deploy and then click [Deploy] .

Delete an object.

To delete objects from the deployable object list:

1. Navigate to > Services > Digital Twin > ARC eye in the NAVER Cloud Platform console.
2. Navigate to Visual Object Tracking > API .
3. Select a project you want from the Project name dropdown list.
4. Click the [Deployable object] tab menu.
5. Click the object you want to delete and click [Delete selection] .
6. Once the Delete object pop-up window appears, click [Delete] .

API service operations

After you create an object through tagging, an API is created. You can deploy this API for service. To operate API services:

1. Navigate to > Services > Digital Twin > ARC eye in the NAVER Cloud Platform console.
2. Navigate to Visual Object Tracking > API .
3. Select a project you want from the Project name dropdown list.
4. Click the [API list] tab menu.
5. Once the API list is displayed, proceed with the next task as needed.
   • Create API integration key and check invoke URL
   • Start API service (deployment)
   • Stop API service

Create API integration key and check invoke URL

Create the API secret key to ensure that only the users with API service usage permissions can access and call the API. Invoke URL is an endpoint that you call to receive API data you created. API users, including app developers, must use API integration key + Invoke URL to call the API. To create and view an API integration key:

1. Click [Check API integration key] .
2. Click [Create] at the Secret Key field on the Check API integration key pop-up window.
   • API integration key is generated in the item field.
   • Click [Copy] to copy the created API integration key to your clipboard.
3. View Invoke URL at Invoke URL .
   • Invoke URL is created automatically upon creating a project.
   • To copy the invoke URL to your clipboard, click [Copy address] .

Start API service (deployment)

To deploy the API, click and select an API from the list and click [Deploy] .

• In case of the initial deployment, the deployment status changes from Standby to Completed, and [Stop API service] is activated.
• In case of deploying a stopped API, the deployment status changes from Stopped to Completed, and the [Stop API service] button is activated.
• You can deploy 1 API per project. In case of a project with multiple versions of API, the currently deploying API automatically stops, once you deploy an API in the Standby or Stopped status.

Stop API service

To stop a running API, click an API from the list and click [Stop API service] .

• Once the API service stops, the deployment status will change from Completed to Stopped, and [Deploy] is activated.
• To deploy an API service again, select an API from the list and click [Deploy] .

Delete API

To delete an API:

1. Navigate to > Services > Digital Twin > ARC eye in the NAVER Cloud Platform console.
2. Navigate to Visual Object Tracking > API .
3. Select a project you want from the Project name dropdown list.
4. Click the [API list] tab menu.
5. If the API you want to delete is deployed, click and select the API and click [Stop API service] to stop the API deployment.
6. Click the API you want to delete and click the [Delete selection] .
7. When the Delete API pop-up window appears, click [Delete] .