질문이 있으십니까?

기본 컨텐츠 및 사용자가 직접 참여하여 만들어진 다양한 내용을 검색합니다.

EIS(경영정보) 자동입력 기능 API

1. 기능 정의

본 OpenAPI는 타시스템에서 각종 이벤트 발생시 해당 이벤트의 정보를 지오유 그룹웨어의 EIS시스템에 등록하는 기능입니다. 여기서 타시스템이란 주로 고객사에서 별도 관리하는 외부 시스템을 말합니다. 본 OpenAPI를 이용하실때는 아래에 정의되어 있는 규칙에 맞추어 지오유 그룹웨어로 정보를 넘겨주어야 합니다.

2. Link URL

보안을 위해 Https 만 허용합니다.

https://wininet.zioyou.com/syncClass/Eis_SysAutoInput

3. Method

POST 방식 (GET방식으로는 받지 않습니다)

4. 파라미터

아래의 인자값을 JSON 형식으로 전달
  • edate : (필수입력항목) 이벤트일시, 19자, "YYYY-MM-DD HH:mm:ss" 형식
  • ebasicval : (선택입력항목) 이벤트 기준값, 최대15자(한글기준)<br> - 공백값 처리가 가능<br> - 값이 있는 경우 센서의 데이터형식이 숫자인 경우 숫자 이외의 문자가 넘어오면 에러코드(ErrCode:-904) 반환
  • evalue : (필수입력항목) 이벤트값, 최대15자(한글기준)<br> - 값이 반드시 존재해야 함<br> - 데이터형식이 숫자인 센서의 경우 숫자이외의 값이 입력되면 에러코드(ErrCode:-904)를 반환.
  • ememo : (선택입력항목) 이벤트내용, 최대300자(한글기준)
  • AuthKey : (필수입력항목) 인증키<br> - 자동등록할 센서(지오유.eis에 사전 등록한 센서)별로 인증키가 필요합니다 (예: EIS에 등록해 놓으신 자동입력용 센서가 두개인 경우 각각 인증키를 발급 받아야 합니다.)

AuthKey(인증키) 발급 절차

1. 지오유.eis에서 자동입력할 센서 등록
2. 고객정보(업체명, 그룹웨어 등록도메인, 신청자명, 연락서), 등록한 센서정보(센서명)를 기재하여 developer@zioyou.com 으로 AuthKey신청메일 발송
3. 지오유에서 검토 후 AuthKey 발급하여 메일회신
4. 발급받은 AuthKey를 이용하여 자동입력 적용

5. 결과 반환 값

JSON 형식의 문자열로 에러코드 및 에러내용을 반환합니다.
  • 0 : "The operation was successful."<br> 작업성공
  • 15735 : "The authentication key is invalid or revoked keys."<br> 허가된 인증키가 아닙니다.
  • 17406 : "It calls only place allowed the [호출지] are allowed."<br> 허가된 호출지에서의 호출이 아닙니다.
  • 18304 : "The blank value was passed."<br> 파라미터로 전달된 유효한 값이 없습니다.
  • 19204 : "Calls can not be duplicated repeatedly allowed."<br> OpenAPI를 악의적인 목적으로 연속하여 호출했을 때, 반환하는 메시지
  • -901 : "Unregistered company or sensor."<br> 등록되지 않은 업체 또는 센서입니다.
  • -902 : "Sensor is not automatically registered."<br> 자동입력으로 설정된 센서가 아닙니다.
  • -903 : "The date format is not valid."<br> 이벤트일시의 형식이 잘못되었습니다.
  • -904 : "The value format is not valid."<br> 이벤트 값 또는 기준값의 형식이 잘못되었습니다. (숫자값 입력 센서에 숫자값이 아닌값이 입력되었을 경우 발생)
  • -999 : "Problems occurred during data processing."<br> 처리작업중 문제가 발생했습니다. (developer@zioyou.com 으로 문의요망)

결과 반환 값 예시
성공예시 : '{"ErrCode":"0", "ErrMessage":"The operation was successful."}'
실패예시 : '{"ErrCode":"18304", "ErrMessage":"The blank value was passed"}'

6. 작업 시 유의사항

  1. 반드시 호출할때는 https 프로토콜로 호출하셔야 합니다.(보안사항)
  2. 호출 method는 post 방식으로만 하셔야 합니다.
  3. 서버Side 페이지의 연동이 아니라 클라이언트Side의 연동일 경우 , 본 OpenAPI를 호출하고 바로 submit으로 페이지를 이동한다면 OpenAPI 작업도중 취소될 수 있습니다. 이런경우, 저희 OpenAPI의 결과절 success 또는 fail 이벤트 처리 이후 submit을 위치시키도록 권장합니다. 웹의 기본 속성은 하나의 URL 호출 도중 다른 URL로의 페이지 전환이 발생하면 기존 URL은 작업도중 멈추게 됩니다. (w3c의 일반사항)
  4. OpenAPI를 중복해서 연속적으로 호출 시, 공격으로 간주하여 실패오류를 반환하며 지속될 경우 사전통보없이 차단될 수 있습니다.
  5. 본 OpenAPI를 사용하기 전에 운용할 사이트에 필요한 인증키(AuthKey)를 사전에 발급받으셔야 합니다.

댓글을 작성하세요

문서 이력

  • 2021-06-04 날짜로 panuker 님으로 부터 컨텐츠명이 변경 되었습니다.
  • 2021-06-22 날짜로 panuker 님께서 등록 작업을 하였습니다.