서비스 세부 절차¶
OVS 플랫폼을 사용하려는 파트너분들은 하기의 절차를 참고하셔서 진행하셔야 합니다.
전체 절차¶
OVS 플랫폼을 이용하기 위한 절차는 다음과 같이 구성되어 있으며, SK open API 포털에서 제공하는 OVS API 혹은 본 OVS 웹문서 에서 확인할 수 있습니다.
SK open API 가입¶
OVS 플랫폼 및 API는 SK open API 포털 가입후 이용할 수 있습니다. https://openapi.sk.com 접속 후 “회원가입” 메뉴를 통해 가입절차를 진행합니다.
프로젝트 생성¶
OVS API 사용을 위해 SK open API 포털내 “My Project” 메뉴에서 “프로젝트 생성” 하면 신규 프로젝트가 생성됩니다.
생성된 프로젝트는 “My Project”의 “Dashboard” 메뉴에서 확인할 수 있으며, 이후 “Service” 메뉴에서 OVS API를 추가하면 해당 프로젝트에서 OVS API를 사용할 수 있습니다.
동일 프로젝트를 여러명의 사용자가 관리하는 경우 “My Project”의 “Team” 메뉴에서 멤버를 추가할 수 있습니다.
토큰 조회¶
OVS API 호출시 인증을 위하여 유효한 auth token을 포함하여야 하며, 다음 두 가지 token이 필요합니다.
SK open API 접근을 위한 auth token¶
프로젝트를 생성하면, My Project의 Key 탭의 Project Key에서 확인가능합니다.
이후 API의 parameter로 app key 입력이 필요합니다.
단말 등록¶
OVS API가 포함된 프로젝트가 생성된 경우 API 호출 혹은 API 콘솔에서 단말 등록 가능합니다. 단말등록은 단말 ID(serialNo)와 단말 credential(credentialsId)의 조합으로 이루어지며 회사코드(company prefix)가 앞부분에 포함되어 있어야 합니다.
단말 credential(credentialsId)은 5자리의 회사코드(company prefix)와 15자리의 개별암호로 이루어지며, 단말 ID(serialNo)는 길이의 제한은 없습니다.
TBD: SK open API console을 통하여 등록하는 장면 캡쳐
| Key | Type | Description | Example |
|---|---|---|---|
| credentialsId | string | {company prefix}{unique no} | csx13123451234500001 |
| serialNo | string | {company prefix}{device serialNo} | csx13123451234500001 |
단말등록 API의 세부 필드는 5.2 단말 등록 을 참조하세요.
단말-OVS플랫폼간 연동절차 및 프로토콜은 6. Device 연동 절차 를 참조하세요.
TBD: SK open API console을 통하여 등록하는 장면 캡쳐(현재 화면없음)
단말 통계 조회¶
OVS플랫폼에 단말 등록 및 연동절차가 진행되었으면 OVS 서비스를 받을 수 있으며, 단말별, 서비스별 통계를 조회할 수 있습니다.