RESTful API로 KPI 데이터 입력을 자동화하세요
RESTful API로 KPI 데이터 입력 및 읽기를 자동화하세요. 서드 파티 사업 도구를 위한 데이터에 자동으로 접속하세요.
일반 정보
- 기록 API 콜의 기록은 이곳에서 가능합니다.
- 웹북 BSC Designer의 알람 기능은 웹북을 발송하도록 설정될 수 있습니다.
- 한계 API는 파워 유저마다 한 시간 당 총 100개까지 받을 수 있습니다.
시작하기
시작하는데 도움을 얻으려면 아래 설명을 참고하시기 바랍니다.
허가 징표
API 콜을 위해서는 API 키 또는 임시 허가 징표가 필요합니다..
새로운 API 키를 만드시려면 아래 단계를 따라주세요:
- 설정 섹션으로 이동하세요
- 통합 탭으로 전환하세요
- API Key 추가 버튼을 클릭하세요
추가된 API 키 매개 지수(Parameter)를 모든 API 콜의 헤더에 사용하세요:
POST /rest/login HTTP/1.1
Host: https://www.webbsc.com
Content-Type: application/json
Token: replace_with_obtained_token
성과표와 KPI ID 만들기
KPI와 관련된 API 콜은 성과표의 ID와 GUID(고유 식별자)가 필요합니다.
성과표 ID 얻기
성과표 ID는 API 콜을 통해서 혹은 수동으로 얻을 수 있습니다. 성과표 ID를 수동으로 얻기 위해서:
- 나의 성과표 섹션으로 이동하세요
- ID를 얻고자하는 성과표를 여세요.
- 성과표의 URL은 이와같이 표기됩니다.: https://www.webbsc.com/s/123456
- 마지막 번호가 성과표의 ID입니다.
KPI GUID(고유 식별자) 얻기
KPI GUID는 API 콜을 통해서 혹은 수동으로 얻을 수 있습니다. GUID를 수동으로 얻기 위해서:
- 성과표를 여세요.
- 도구 > 인디케이터 값 내보내기를 클리하세요.
- 내보낸 결과 미리보기 페이지를 보기 위해 다음 단계를 따르세요.
- 미리보기 테이블에서 GUID 열이 KPI GUID를 포함하고 있습니다.
API를 이용하여 데이터값 입력 및 읽기
KPI 데이터값을 읽고 입력하려면 KPI 값 컨트롤러를 이용하세요.
- 요청 헤더에서 토큰을 사용하는 것을 잊지 마세요
- 데이터는 yyyy-MM-dd 포멧의 형식이어야 합니다. (예를 들어 "2017-06-30")
- 데이터는 JSON 포멧으로 수신 및 발신됩니다.
- 콜 넘버를 최적화하시려면 일괄 처리 콜(batch call)을 이용하세요
- 계산 및 그룹화되고 인헤리트(Inherited)된 값을 읽기 위해서 그룹값 컨트롤러를 이용하세요
API 사용의 php 예시를 확인하세요.