POST /login
Parameter | Description | Example |
---|---|---|
username | SNU ID | dyd1928 |
password | SNU Password | ... |
auto | 자동 로그인 여부 | false |
auto
가 true
이면, username
과 password
는 필요없습니다
auto
가 true
이면, 후술할 token
이 필요합니다
로그인이 성공했을 경우
{
"result": true,
"token": "나중에 엄청 써야 하는 토큰"
}
로그인 하기 이외의 API에는 HTTP Request Header에 위의 토큰이 포함되어야 합니다.
x-user-token=token
로그인에 실패했을 경우
{
"result": false,
"message": "실패 사유"
}
로그인에 성공했으면, 푸시 알림을 위해서 FCM 토큰을 등록해야합니다. Firebase Cloud Messaging 문서를 참고하여 토큰을 발급받은 후 아래의 API로 우리 서버에 토큰을 보내주세요.
x-user-token
을 싣는 것을 잊지 말아주세요.
POST /fcm
Parameter | Description |
---|---|
token (required) | 발급받은 FCM 토큰 |
{
"success": 성공 여부
}
특정 게시판의 공지 목록을 가져옵니다
x-user-token
을 싣는 것을 잊지 말아주세요.
GET /notices
Parameter | Description | Example | Remarks |
---|---|---|---|
board | 볼 게시판 | SNU | 필수 |
count | 가져올 글 개수 | 10 | default = 15 |
max_id | 이전 글 아이디 | ||
since_id | 다음 글 아이디 | ||
query | 검색어 |
게시판 코드는 다음을 참고하세요
게시판 이름 | 코드 |
---|---|
마이스누 | SNU |
공과대학 | ENG |
건설환경공학부 | CEE |
기계공학전공 | ME |
우주항공공학전공 | AER |
재료공학부 | MSE |
전기정보공학부 | EE |
컴퓨터공학부 | CSE |
화학생물공학부 | CBE |
건축학부 | ARC |
산업공학과 | IE |
에너지자원공학과 | ERE |
원자핵공학과 | NUC |
조선해양공학과 | SHI |
경력개발센터 | CAR |
국제협력본부 | OIA |
장학/학자금지원안내 | SCH |
max_id
와 since_id
에 대해서는 트위터 timeline API 문서를 참고하세요
대략적인 동작은 다음과 같습니다
id
가 클수록 최신의 글입니다max_id
와since_id
사이의count
만큼의 아이템을 줍니다max_id
부터 세어나갑니다- 없으면 처음부터 셉니다
since_id
를 만나면 그만둡니다- 없으면
count
개수가 차거나 끝까지 셉니다
- 없으면
{
"notices": [
{
"pk": 1,
"fields" : {
"title": ,
"category": ,
"date": ,
"url": ,
}
},
...
],
}
카테고리 코드표는 다음을 참고하세요
카테고리 이름 | 코드 |
---|---|
장학/학자금 | SCLR |
채용 | HIRE |
수업/성적 | STUD |
학사 | STAT |
교환학생 | EXCH |
공모전 | CONT |
봉사/멘토링 | SERV |
학회/세미나 | CONF |
교육 | EDUC |
대학원 | GRAD |
기타 | EXTC |
GET /notices/:id
Parameter | Description | Example |
---|
|
공지 객체가 내려옵니다
{
"pk": 1,
"fields" : {
"title": ,
"category": ,
"date": ,
"url": ,
"file_count": ,
}
}
GET /notices/:id/files
{
"file_count": ,
"files" [
{
"url": 주소,
"title": 파일제목,
}
],
}
서버로부터 오는 메시지입니다
아까의 FCM 문서를 참고하세요
푸시 알림 데이터