API 개요

해당 문서에서는 API별 request URL과 공통 메세지 포맷을 확인하실 수 있습니다. 상세 내용은 각 API별 문서를 확인해주세요.

1. Request URL

구분

설명

Method

URL

회사정보 API

내 회사 정보 조회

GET

https://apis.openapi.sk.com/api/ovs/v20/company/info/me

회사정보 API

회사 정보 조회

GET

https://apis.openapi.sk.com/api/ovs/v20/company/info/{companyId}

회사정보 API

전체 단말 정보 조회

GET

https://apis.openapi.sk.com/api/ovs/v20/company/info/devices/{companyId}

회사정보 API

전체 단말 수 조회

GET

https://apis.openapi.sk.com/api/ovs/v20/company/info/devices/cnt/{companyId}

단말정보 API

단말 등록

POST

https://apis.openapi.sk.com/api/ovs/v20/device

단말정보 API

단말 정보 조회

GET

https://apis.openapi.sk.com/api/ovs/v20/device/{serialNo}

단말정보 API

단말 삭제

DELETE

https://apis.openapi.sk.com/api/ovs/v20/device/{serialNo}

Message Notification API

전체 단말에 메시지 전달

POST

https://apis.openapi.sk.com/api/ovs/v20/message/company/{companyId}

Message Notification API

단말별 메시지 전달

POST

https://apis.openapi.sk.com/api/ovs/v20/message/device/{serialNo}

이벤트 통계 API

특정 회사 단말의 기간별 이벤트 통계

GET

https://apis.openapi.sk.com/api/ovs/v20/statistics/company/event/{companyId}

이벤트 통계 API

특정 단말 기간별 이벤트 통계

GET

https://apis.openapi.sk.com/api/ovs/v20/statistics/device/event/{serialNo}

이벤트 Raw Data API

기간별 이벤트 Raw Data

GET

https://apis.openapi.sk.com/api/ovs/v20/statistics/event/raw

2. 공통 메세지 포맷


* 본 장에 명세된 표 내용 중 M / O 는 Mandatory / Optional 의 약자로, Mandatory는 필수로 포함해야 하는 데이터를 Optional은 필요에 따라 기입 여부를 개발사에서 판단하시면 됩니다.


2.1. 메세지 기본 구조


* OVS 플랫폼의 기본 메세지 구조는 JSON Format으로 Header, Payload가 구분이 없이 구성되어있습니다.

Example Code
{
    "timestamp" : 1571273913571,  //timestamp
    "devType": 2,
    "devId": 3333,
    "speed": 60,
    "location": {
        "latitude": 37.510296,
        "longitude": 127.062512
    }
}




메세지의 종류는 Device Type과 송/수신 대상에 따라 세부내용이 달라집니다.