API v2

교육부 자가진단 API v2에 관한 내용

Table of Contents API findUser hasPassword validatePassword selectUserGroup getUserInfo registerServey

API

모든 요청 방식은 POST입니다. URL: https://{지역}hcs.eduro.go.kr/v2/*

암호화 방식에 대해서는 암호화 항목을 확인하십시오.

findUser

• 요청 인자(JSON)

{

  orgCode: 기관 코드,
  name: 성명(암호화),
  birthday: 생년월일(암호화),
  loginType: 로그인 종류(school, office, univ),
  stdntPNo: 학번(대학교만. 암호화. 이외는 null로 설정)

}

• 출력 인자(JSON)

{

  orgName: 기관명,
  admnYn: 시스템 관리자 여부(Y/N),
  atptOfcdcConctUrl: 자가진단 서버 주소,
  mngrClassYn: 학급 관리자 여부(Y/N),
  pInfAgrmYn: 개인정보 활용 동의 여부(Y/N),
  userName: 성명,
  stdntYn: 학생 여부(Y/N),
  token: JWT 토큰,
  mngrDeptYn: 부서 관리자 여부(Y/N)

}

hasPassword

• 요청 인자(헤더)

- Authorization: findUser에서 발급된 JWT 토큰

• 출력 내용

비밀번호 설정 여부(boolean)

validatePassword

• 요청 인자(헤더)

- Authorization: findUser에서 발급된 JWT 토큰

• 요청 인자(JSON)

{

 deviceUuid: 기기 Uuid
 password: 자가진단 비밀번호(암호화)

}

• 출력 내용

JWT 토큰

selectUserGroup

• 요청 인자(헤더)

- Authorization: validatePassword에서 발급된 JWT 토큰

• 출력 인자(JSON)

[{

 orgCode: 기관코드,
 orgName: 기관명,
 userPNo: 기관 내 사용자 등록번호,
 userNameEncpt: 성명,
 stdntYn: 학생 여부(Y/N),
 mngrYn: 관리자 여부(Y/N),
 schulCrseScCode: 학교급 코드,
 lctnScCode: 지역 코드,
 token: JWT 토큰,
 atptOfcdcConctUrl: 자가진단 서버 주소,
 wrongPassCnt: 비밀번호 오류 횟수,
 otherYn: 다른 사람 존재 여부(Y/N)

}]

getUserInfo

• 요청 인자(헤더)

- Authorization: selectUserGroup에서 발급된 JWT 토큰

• 요청 인자(JSON)

{

 orgCode: 기관 코드
 userPNo: 기관 내 사용자 등록번호

}

• 출력 인자(JSON)

{

 orgCode: 기관 코드,
 orgName: 기관명,
 userNameEncpt: 성명,
 userName: 성명,
 stdntYn: 학생 여부(Y/N),
 mngrClassYn: 학급 관리자 여부(Y/N),
 mngrDeptYn: 부서 관리자 여부(Y/N),
 schulCrseScCode: 학교급 코드,
 lctnScCode: 지역 코드,
 insttClsfCode: 기관분류코드,
 deviceUuid: 기기 Uuid,
 token: JWT 토큰,
 atptOfcdcConctUrl: 자가진단 서버 주소,
 registerDtm: 자가진단 실시 일시,
 registerYmd: 자가진단 실지 일자,
 isHealthy: 자가진단 통과 여부(boolean),
 pInfAgrmYn: 개인정보 활용 동의 여부(Y/N),
 admnYn: 시스템 관리자 여부(Y/N),
 lockYn: 계정 잠김 여부(Y/N),
 wrongPassCnt: 비밀번호 오류 횟수,
 upperUserName: 성명,
 extSurveyCount: 추가 설문조사 수,
 extSurveyRemainCount: 아직 하지 않은 추가 설문조사 수

}

registerServey

API/v1의 해당 부분을 참고하세요.