API 사용 방법

API를 사용하기 위해서는, VlabON 사이트에서 제공하는 Platform.api.js에 대한 스크립트 선언을 사용하려는 웹 페이지에 삽입합니다.

<script src="https://vlabon.re.kr/js/Platform.api.js"></script>

Platform.api.js는 순수 JavaScript로 구현되어 jQuery 등 다른 Library를 필요로 하지 않습니다.

Platform.api는 이 스크립트 태그를 삽입한 웹 페이지가  "vlabon.re.kr"에서 호출된 것인지 여부를 체크하여 동작(운영, 개발) 모드가 선택됩니다. 개발모드인 경우에는 VlabON 서비스의 실제값이 아닌, 호출시 전달받은 개발용 추가 파라미터 값을 응답(Promise의 resolve로 호출)으로 제공합니다.

호출 예시

// 사용자 정보 조회 예시: 성공시
Platform.api.getUserInfo({
  result: "SUCCESS",
  data: {
    nickname: '테스터', 
    birthYear: 1980, 
    residence: '세종'
  }
}).then(function(response) { ... });

// 사용자 정보 조회 예시: 실패
Platform.api.getUserInfo({
   result: "FAIL",
   message: "로그인 상태가 아닙니다",
   help: "로그인 후 이용해 주십시오."
}).then(function(response) { ... });

// 실행 데이터 저장 예시: 성공시
Platform.api.savePlayData(
  'POINT',
  JSON.stringify({ point: 86 }),
  {
    result: "SUCCESS",
    data: {
        historyNo: 152,
        seqNo: 1,
        saveTime: new Date()
    }
  }
).then(function(response) { ... });