API

Classic/VPC 환경에서 이용 가능합니다.

API에서는 생성한 객체에 대한 Visual Object Tracking API를 배포, 운영, 관리하는 방법을 설명합니다.

참고

API 사용 시 과금이 발생합니다. 자세한 내용은 포털 > 서비스 > Digital Twin > ARC eye를 참조해 주십시오.
API 이용에 관한 자세한 내용은 ARC eye API 가이드를 참조해 주십시오.

API 화면

API 화면은 다음과 같이 구성되어 있습니다.

arceye-votapi_01_ko

영역	설명
① 메뉴명	현재 확인 중인 메뉴 이름
② 기본 기능	API 메뉴 최초 진입 시 표시되는 기능 [기능 및 요금 안내]: 클릭하여 ARC eye 서비스 소개 페이지로 이동 [새로 고침]: 클릭하여 페이지 새로 고침
③ 프로젝트 선택	API 관리 대상 프로젝트를 드롭다운 목록에서 선택
④ 탭 메뉴	API 목록: API 배포 화면 표시 배포 가능한 오브젝트: API를 통해 서비스할 오브젝트 배포 화면 표시
⑤ 검색창	오브젝트 이름을 입력하여 검색 가능
⑥ 선택 삭제	선택한 작업 데이터 삭제
⑦ 배포	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를 통해 배포할 오브젝트를 선택하여 배포합니다. 오브젝트는 최대 20개까지 한 번에 배포가 가능하며, 오브젝트 배포 시 이전 버전의 API 배포는 중지됩니다. 오브젝트를 선택하여 배포한 후에는 [API 목록] 탭 메뉴로 이동하여 API를 배포해 주십시오. 오브젝트를 배포하는 방법은 다음과 같습니다.

네이버 클라우드 플랫폼 콘솔에서 > Services > Digital Twin > ARC eye 메뉴를 차례대로 클릭해 주십시오.
Visual Object Tracking > API 메뉴를 차례대로 클릭해 주십시오.
프로젝트 이름 드롭다운 목록에서 원하는 프로젝트를 선택해 주십시오.
[배포 가능한 오브젝트] 탭 메뉴를 클릭해 주십시오.
오브젝트 목록이 표시되면 배포할 오브젝트를 클릭하여 선택한 다음 [배포] 버튼을 클릭해 주십시오.

오브젝트 삭제

배포 가능 오브젝트 목록에서 오브젝트를 삭제하는 방법은 다음과 같습니다.

네이버 클라우드 플랫폼 콘솔에서 > Services > Digital Twin > ARC eye 메뉴를 차례대로 클릭해 주십시오.
Visual Object Tracking > API 메뉴를 차례대로 클릭해 주십시오.
프로젝트 이름 드롭다운 목록에서 원하는 프로젝트를 선택해 주십시오.
[배포 가능한 오브젝트] 탭 메뉴를 클릭해 주십시오.
삭제할 오브젝트를 클릭하여 선택한 후 [선택 삭제] 버튼을 클릭해 주십시오.
오브젝트 삭제 팝업 창이 나타나면 [삭제] 버튼을 클릭해 주십시오.

API 서비스 운영

태깅 작업을 통해 객체 생성 후 API가 생성되며, 이 API를 배포하여 서비스할 수 있습니다. API 서비스를 운영하는 방법은 다음과 같습니다.

네이버 클라우드 플랫폼 콘솔에서 > Services > Digital Twin > ARC eye 메뉴를 차례대로 클릭해 주십시오.
Visual Object Tracking > API 메뉴를 차례대로 클릭해 주십시오.
프로젝트 이름 드롭다운 목록에서 원하는 프로젝트를 선택해 주십시오.
[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개의 API를 배포할 수 있습니다. 여러 버전의 API를 가진 프로젝트에서 대기 또는 중지 상태인 API를 배포하면, 현재 배포 중인 API는 자동으로 서비스 중지 상태가 됩니다.

API 서비스 중지

서비스 중인 API를 서비스 중지하려면 목록에서 API를 클릭하여 선택한 후 [API 서비스 중지] 버튼을 클릭해 주십시오.

API 서비스가 중지되면 목록의 배포 상태가 완료에서 중단으로 변경되고, [배포] 버튼이 활성화됩니다.
API 서비스를 재배포하려면 목록에서 API를 선택한 후 [배포] 버튼을 클릭해 주십시오.

API 삭제

API를 삭제하는 방법은 다음과 같습니다.

주의

API를 삭제하면 해당 API에 등록된 데이터가 모두 삭제되어 복구할 수 없으며, 연동 중인 다른 작업과 이용 중인 API 서비스에 문제가 발생할 수 있으므로 신중하게 결정해 주십시오.

참고

배포가 완료된 API는 삭제할 수 없습니다. 먼저 해당 API를 API 서비스를 중지한 후 API 삭제를 진행해 주십시오.

네이버 클라우드 플랫폼 콘솔에서 > Services > Digital Twin > ARC eye 메뉴를 차례대로 클릭해 주십시오.
Visual Object Tracking > API 메뉴를 차례대로 클릭해 주십시오.
프로젝트 이름 드롭다운 목록에서 원하는 프로젝트를 선택해 주십시오.
[API 목록] 탭 메뉴를 클릭해 주십시오.
삭제할 API가 API 배포 중인 경우 API를 클릭하여 선택한 후 [API 서비스 중지] 버튼을 클릭해 API 배포를 중지해 주십시오.
삭제할 API를 클릭하여 선택한 후 [선택 삭제] 버튼을 클릭해 주십시오.
API 삭제 팝업 창이 나타나면 [삭제] 버튼을 클릭해 주십시오.