4. 구성요소(Entity) 등록¶

OVS 서비스 활용을 위해서는 기본 Entity인 회사와 단말의 등록이 필요합니다.

Note

기본적으로 SK open API를 통한 OVS 서비스의 구매를 가정하고 그 절차를 기술합니다.

4.1. 회사 등록 (Company Registration)¶

회사는 SK open API 포털내 프로젝트에서 OVS API를 구매하면 자동으로 생성 및 등록됩니다.

생성된 회사의 정보 확인은 6. Northbound API Specification 에 명세된 API를 이용하여 하실 수 있습니다.

4.2. 단말 등록 (Device Registration)¶

단말 등록을 위해서는 다음의 3가지를 확인하여 진행하시기 바랍니다.

4.2.1. Auth Token¶

OVS 플랫폼 사용을 위해서는 단말이 등록되어야 하며, 유효한 auth token을 포함한 OVS API로 등록할 수 있습니다. token 조회 방법은 4.4 토큰 조회 을 참조하세요.

4.2.2. Company Prefix¶

단말등록시 단말의 일련번호(SerialNo)와 단말비밀번호(CredentialsId)는 정해진 규칙을 따라야 하며, 둘 필드 모두 5자리의 company prefix로 시작해야 합니다. company prefix는 7.2.2 내 회사 정보 조회 API로 조회할 수 있습니다.

4.2.3. 단말 등록 API¶

POST

/api/ovs/v1/device

Header

option	Type	Default	Description
Content-Type	string	application/json	content type
X-Authorization	string	Bearer {{token}}	auth token

Body

Key	Type	Enum	Description
vendor	string		vendor or manufacturer
type	string	OVC-G, OVC-M	OVS device type
credentialsId	string		Device credential company prefix(5) + unique no.(15)
serialNo	string		Device Serial No. company prefix(5) + unique no.
~modelName~	string		~device model name~
~modelCode~	string		~device model code~
~additionalInfo~	string		~additional device info~

Example Code

Request

content-type:"application/json"
X-Authorization: "Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJzeXNhZG1pbkB0aG…"
{
    "vendor": "SKT",
    "type": "OVC-G",
    "credentialsId":"{{prefix}}123456789012345",
    "serialNo":"{{prefix}}12345678911234"
}

Response (code: 200)

{
    "id": {
        "id": "128fe3e0-ab98-11ea-b482-911940102f00"
    },
    "createdTime": 1591848022149,
    "companyId": {
        "id": "f58ccd10-a0bd-11ea-a9b8-ff6a8104c32f"
    },
    "vendor": "SKT",
    "type": "OVC-G",
    "additionalInfo": null,
    "activationRequired": false,
    "serialNo": "uio3512345678911234",
    "credentialsId": "uio35123456789012345"
}

요청이 성공하면(code:200) Response에서 Device ID를 얻을 수 있습니다. Device ID는 Response 데이터에 있는 id 필드 내의 id 값입니다. 예시에 있는 128fe3e0-ab98-11ea-b482-911940102f00 값이 Device ID입니다.