-
Notifications
You must be signed in to change notification settings - Fork 0
/
eduro-hcs.yaml
98 lines (87 loc) · 3.54 KB
/
eduro-hcs.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
openapi: 3.0.3
info:
title: eduro-hcs
description: | # language=markdown
**이 문서는 아직 완성되지 않았으며, 정상적으로 작동한다는 보장이 없습니다!**
lhwdev가 만든 eduro-hcs(https://hcs.eduro.go.kr)의 비공식 openapi 스펙입니다.
이 api의 url은 `???`가 3자리 교육부 코드(`sen`, `dge` 등)일 때, `https://???hcs.eduro.go.kr`이여야 합니다.
`https://hcs.eduro.go.kr`에 위치한 api는 [eduro-hcs-common.yaml](eduro-hcs-common.yaml)을 참고하세요.
문서를 웹사이트에서 열면 브라우저가 CORS를 막기 때문에, Chrome, Firefox 등 웹브라우저의
web security를 끈 인스턴스를 새로 시작해야 합니다.
```shell
"크롬 경로\chrome.exe" --disable-web-security --disable-gpu --user-data-dir=%Temp%/chromeTemp # 크롬의 경우
```
contact:
email: [email protected]
version: 1.7.59 # aligned with UI version of hcs: https://hcs.eduro.go.kr/#/main
servers: # https://www.moe.go.kr/sub/info.do?m=060104 참고
- url: https://senhcs.eduro.go.kr
description: 서울특별시 교육청
- url: https://penhcs.eduro.go.kr
description: 부산광역시 교육청
- url: https://dgehcs.eduro.go.kr
description: 대구광역시 교육청
- url: https://icehcs.eduro.go.kr
description: 인천광역시 교육청
- url: https://genhcs.eduro.go.kr
description: 광주광역시 교육청
- url: https://djehcs.eduro.go.kr
description: 대전광역시 교육청
- url: https://usehcs.eduro.go.kr
description: 울산광역시 교육청
- url: https://sjehcs.eduro.go.kr
description: 세종특별자치시 교육청
- url: https://goehcs.eduro.go.kr
description: 경기도 교육청
- url: https://kwehcs.eduro.go.kr # 없음
description: 강원도 교육청
- url: https://cbehcs.eduro.go.kr
description: 충청북도 교육청
- url: https://cnehcs.eduro.go.kr
description: 충청남도 교육청
- url: https://jbehcs.eduro.go.kr
description: 전라북도 교육청
- url: https://jnehcs.eduro.go.kr
description: 전라남도 교육청
- url: https://gbehcs.eduro.go.kr # 없음
description: 경상북도 교육청
- url: https://gnehcs.eduro.go.kr
description: 경상남도 교육청
- url: https://jjehcs.eduro.go.kr
description: 제주도 교육청
- url: https://kwehcs.eduro.go.kr
components:
securitySchemes:
UsersIdToken:
type: http
scheme: bearer
paths:
/v2/findUser:
post:
summary: 사용자 정보 찾기
description: |
사용자의 이름, 생일 등으로 사용자가 존재하는지 확인하고, 사용자의 UsersIdToken을 얻습니다.
requestBody:
required: true
content:
application/json:
schema:
type: object
items:
properties:
orgCode:
$ref: './schemas/InstituteCode.yaml'
name:
responses:
200:
description: 사용자를 찾음
/v2/hasPassword:
post:
summary: 비밀번호 존재 유무/UsersIdToken 얻기
description: |
대상 사용자가 비밀번호가 있는지 확인합니니다.
만약 이 api의 결과가 false(비밀번호 없음)이라면 자가진단 공식 사이트/앱으로 안내하거나,
`/v2/registerPassword`를 호출해서 비밀번호를 정하세요.
security:
- UsersIdToken: []
responses: