ํ๋ก์ ํธ ๋ฐ ์๋น์ค ๊ด๋ฆฌ API ๊ฐ์ด๋ (v1.2)
GIIP ํ๋ซํผ ๋ด์ ์กฐ์ง(ํ๋ก์ ํธ)๊ณผ ์๋น์ค ๊ทธ๋ฃน์ ๊ด๋ฆฌํ๊ธฐ ์ํ API ๋ช ์ธ์ ๋๋ค.
๐ ํ๋ก์ ํธ ๋ชฉ๋ก ๊ธฐ๋ฅ ํ์ด์ง๋ก ์ด๋ โ ยท ๐ฅ ์ฌ์ฉ์ ๋ชฉ๋ก ๊ธฐ๋ฅ ํ์ด์ง๋ก ์ด๋ โ
๐ ๊ฐ์
ํ๋ก์ ํธ(๊ณ ๊ฐ) ๋ฐ ์๋น์ค ๊ทธ๋ฃน API๋ GIIP ์ธํ๋ผ๋ฅผ ๋ ผ๋ฆฌ์ ๋จ์๋ก ๊ตฌ๋ถํ๊ณ ๊ถํ์ ์ ์ดํ๋ ํต์ฌ ๊ธฐ๋ฅ์ ์ ๊ณตํฉ๋๋ค.
๐ ์ธ์ฆ ๋ฐ ๋ณด์
- Header: ๊ณตํต ์ธ์ฆ ํค๋ ํ์
- ๊ถํ: ํ๋ก์ ํธ ์์ฑ/์ญ์ ๋ ๋์ ๋ฑ๊ธ์ ๊ด๋ฆฌ์ ๊ถํ์ด ์๊ตฌ๋ ์ ์์ต๋๋ค.
๐ก API ์์ธ
1. ํ๋ก์ ํธ ๊ด๋ฆฌ
ํ๋ก์ ํธ ๋ชฉ๋ก ์กฐํ (PrjList)
- ๋ช
๋ น:
text=PrjList - ์ค๋ช : ํ์ฌ ์ฌ์ฉ์๊ฐ ์ ๊ทผ ๊ฐ๋ฅํ ๋ชจ๋ ํ๋ก์ ํธ(๊ณ ๊ฐ) ๋ชฉ๋ก์ ๋ฐํํฉ๋๋ค.
- ๋ฐํ์์:
[{"csn":44, "cname":"Acme Corp"}, ...]
ํ๋ก์ ํธ ์ ๊ท ๋ฑ๋ก (PrjPut)
- ๋ช
๋ น:
text=PrjPut <cCode>, '<cName>' - ํ๋ผ๋ฏธํฐ:
cCode: ํ๋ก์ ํธ ์๋ฌธ ์ฝ๋ (Unique)cName: ํ๋ก์ ํธ ํ์ ๋ช ์นญ
- ์์:
text=PrjPut GIIP_DEV, 'GIIP ๊ฐ๋ฐํ'
ํ๋ก์ ํธ ์ญ์ (PrjDel)
- ๋ช
๋ น:
text=PrjDel <CSN> - ์์:
text=PrjDel 44
2. ์๋น์ค ๊ทธ๋ฃน(Project Group) ๊ด๋ฆฌ
์๋น์ค ๋ชฉ๋ก ์กฐํ (PrjGrpList)
- ๋ช
๋ น:
text=PrjGrpList <CSN> - ์ค๋ช : ํน์ ํ๋ก์ ํธ ํ์์ ์๋น์ค ๊ทธ๋ฃน(cgCode ๊ธฐ๋ฐ) ๋ชฉ๋ก์ ์กฐํํฉ๋๋ค.
์๋น์ค ๋ฑ๋ก/์์ (PrjGrpPut)
- ๋ช
๋ น:
text=PrjGrpPut '<CgCode>', <cSn>, '<cgName>', '<cgDesc>' - ์์:
text=PrjGrpPut 'WEB', 44, 'Web Service', 'Primary web application group'
3. ์ฌ์ฉ์ ๊ด๋ฆฌ (Project User Management)
ํ๋ก์ ํธ(CSN)์ ์ํ ์ฌ์ฉ์๋ฅผ ์กฐํยท์ด๋ยท๊ถํ๋ณ๊ฒฝยท์ ๊ฑฐํ๋ API์ ๋๋ค. ์น UI๋ ์ ์ ๋ชฉ๋ก ๊ฐ์ด๋๋ฅผ ์ฐธ๊ณ ํ์ธ์.
ํ๋ก์ ํธ ์ฌ์ฉ์ ๋ชฉ๋ก ์กฐํ (UserList)
- ๋ช
๋ น:
text=UserList csn - jsondata:
{"csn": 44} - ์ค๋ช : ํธ์ถ์๊ฐ ์ํ ํ๋ก์ ํธ(csn)์ ๋ฉค๋ฒ ๋ชฉ๋ก์ ๋ฐํํฉ๋๋ค. ํธ์ถ์๊ฐ ํด๋น ํ๋ก์ ํธ ๋ฉค๋ฒ๊ฐ ์๋๋ฉด ์ค๋ฅ ์์ด ๋น ๋ชฉ๋ก(0๊ฑด)์ ๋ฐํํฉ๋๋ค.
- ๋ฐํ ์ปฌ๋ผ:
usn, uloginid, uname, uemail, uregdt, isPay, uPerCorp(๊ถํ: 1=Member, 49=Owner)
์ฌ์ฉ์ ์ด๋/๋งคํ (PrjUserMap)
- ๋ช
๋ น:
text=PrjUserMap csn uloginid - jsondata:
{"csn": 44, "uloginid": "user@example.com"} - ์ค๋ช
: ์ด๋ฏธ GIIP ๊ณ์ ์ด ์กด์ฌํ๋ ์ฌ์ฉ์(
uloginid=๋ก๊ทธ์ธID, ๋ณดํต ์ด๋ฉ์ผ)๋ฅผ ํ๋ก์ ํธ ๋ฉค๋ฒ๋ก ๋งคํํฉ๋๋ค. ์ ๊ท ๋ฉค๋ฒ์ ๊ถํ์ ํญ์1(Member)๋ก ์์ํฉ๋๋ค. - โ ๏ธ ์ฃผ์:
uloginid์ ํด๋นํ๋ GIIP ๊ณ์ ์ด ์์ง ์์ผ๋ฉด ๋งคํ์ด ์คํจํฉ๋๋ค(retcode 304). userlist ํ์ด์ง์ "์ด๋" ๋ฒํผ์ ์ด API ํธ์ถ๊ณผ ์ด๋ ์ด๋ฉ์ผ ๋ฐ์ก์ ํจ๊ป ์ํํ๋, ์ด API ์คํจ๋ ํ๋ฉด์ ๋ ธ์ถํ์ง ์๊ณ ๋์ด๊ฐ๋๋ค โ ๋์์๊ฐ ๊ฐ์ ์ ์ด๋ฉด ์ด๋ฉ์ผ๋ง ๋ฐ์ก๋๊ณ , ์ค์ ๋ฉค๋ฒ ๋งคํ์ ๋์์๊ฐ ๊ฐ์ ํ ๋ค ์ด API๋ฅผ ๋ค์ ํธ์ถํด์ผ ์๋ฃ๋ฉ๋๋ค. - ๋ฐํ:
retcodeโ200(์ฑ๊ณต),201(๋ฏธ์ธ์ฆ),301(ํธ์ถ์๊ฐ ํด๋น csn ๋ฉค๋ฒ ์๋),304(๋์ ๊ณ์ ์์),305(์ด๋ฏธ ๋ฉค๋ฒ)
์ฌ์ฉ์ ๊ถํ ๋ณ๊ฒฝ (PrjUserPer)
- ๋ช
๋ น:
text=PrjUserPer csn uloginid uper - jsondata:
{"csn": 44, "uloginid": "user@example.com", "uper": 49} - ์ค๋ช : ํ๋ก์ ํธ ๋ฉค๋ฒ์ ๊ถํ์ Member(1) โ Owner(49)๋ก ๋ณ๊ฒฝํฉ๋๋ค. ํธ์ถ์๊ฐ ํด๋น ํ๋ก์ ํธ์ Owner(49)์ฌ์ผ ํ๋ฉฐ, ์๊ธฐ ์์ ์ ๊ถํ์ ์ด API๋ก ๋ณ๊ฒฝํ ์ ์์ต๋๋ค.
- uper ํ์ฉ๊ฐ:
1(Member) ๋๋49(Owner)๋ง ํ์ฉ๋๋ฉฐ, ๊ทธ ์ธ ๊ฐ์ ๊ฑฐ๋ถ๋ฉ๋๋ค. - ๋ฐํ:
RstVal/RstMsgโ200(์ฑ๊ณต),401(๋ฏธ์ธ์ฆ),403(๊ถํ ๋ถ์กฑ/Owner ์๋/์๊ธฐ ์์ ๋์/ํ์ฉ๋์ง ์์ uper ๊ฐ),404(๋์ ์์ ๋๋ ๋น๋ฉค๋ฒ)
์ฌ์ฉ์ ์ ๊ฑฐ (PrjUserDel)
- ๋ช
๋ น:
text=PrjUserDel csn uloginid - jsondata:
{"csn": 44, "uloginid": "user@example.com"} - ์ค๋ช : ํ๋ก์ ํธ ๋ฉค๋ฒ์ญ์ ์ญ์ ํฉ๋๋ค. ์ญ์ ์ฆ์ ํด๋น ์ฌ์ฉ์๋ ํ๋ก์ ํธ์ ๋ชจ๋ ์์ฐ ์ ๊ทผ ๊ถํ์ ์์ต๋๋ค.
- ๋ฐํ:
RstVal/RstMsgโ200(์ฑ๊ณต),201(๋ฏธ์ธ์ฆ),301(ํธ์ถ์๊ฐ ํด๋น csn ๋ฉค๋ฒ ์๋),304(๋์์ด ํ๋ก์ ํธ ๋ฉค๋ฒ ์๋)
๐ก๏ธ Sk3(๊ณ ์ฑ๋ฅ ๋ก๊น ) ํ์ฉ
์ ๊ท ํ๋ก์ ํธ ๋ฑ๋ก์ด๋ ์๋น์ค ๊ทธ๋ฃน ์์ ๊ณผ ๊ฐ์ด ์ธํ๋ผ ์ ๋ฐ์ ๊ตฌ์กฐ์ ์ํฅ์ ์ฃผ๋ ๊ด๋ฆฌ ์์
์, ์์
์ ์ ํฉ์ฑ ํ๋ณด์ ์์ธํ ๊ฐ์ฌ ๋ก๊ทธ(Audit Log)๋ฅผ ์ํด giipApiSk3 ์๋ํฌ์ธํธ๋ฅผ ๊ถ์ฅํฉ๋๋ค.
- ์๋ํฌ์ธํธ:
https://giipfaw.azurewebsites.net/api/giipApiSk3 - ์ฅ์ : ํ๋ก์ ํธ ์์ฑ ์คํจ ์ ํธ์ถ์์ ์์ธ ํ๊ฒฝ ์ ๋ณด(IP, UA)์ StackTrace๋ฅผ ์ฆ์ ๊ธฐ๋กํ์ฌ ์ค์ ์ค๋ฅ๋ ๊ถํ ์ด์๋ฅผ ์ ์ํ๊ฒ ๋ถ์ํ ์ ์์ต๋๋ค.
- ํ์ฉ ํ:
text๋ช ๋ น๊ณผjsondata์ ํ๋ผ๋ฏธํฐ ์นํ ๊ธฐ๋ฅ์ ํ์ฉํ์ฌ ๋ณต์กํ ์๋น์ค ๊ทธ๋ฃน ์ค๋ช ์ด๋ ํ๊ธ ๋ช ์นญ ๋ฑ์ ์ ์ค ์์ด ์์ ํ๊ฒ ๊ด๋ฆฌํ์ญ์์ค.
๐ง ๋ฌธ์ ํด๊ฒฐ
| ์ฆ์ | ์์ธ | ํด๊ฒฐ |
|---|---|---|
| ์์ฒญ์ด ์ธ์ฆ ์ค๋ฅ๋ก ๊ฑฐ๋ถ๋๋ค | ๊ณตํต ์ธ์ฆ ํค๋(x-giip-ak/x-giip-sk)๊ฐ ๋๋ฝ๋จ | ๋ชจ๋ ์์ฒญ์ ๋ ์ธ์ฆ ํค๋๋ฅผ ํฌํจํ๋์ง ํ์ธํฉ๋๋ค |
PrjPut ํธ์ถ์ด ์คํจํ๊ฑฐ๋ ํ๋ก์ ํธ๊ฐ ์์ฑ๋์ง ์๋๋ค | text ๋ช
๋ น ์๊ทธ๋์ฒ(PrjPut <cCode>, '<cName>')๊ฐ ๋ง์ง ์์ | cCode(Unique)์ ๋ฐ์ดํ๋ก ๊ฐ์ผ cName ํ์์ ์ ํํ ๋ง์ถฐ ๋ค์ ํธ์ถํฉ๋๋ค |
PrjDel ์๋ต์ RstVal์ด 0์ด ์๋๋ค | ์๋ชป๋ CSN์ ์ง์ ํ๊ฑฐ๋ ์ญ์ ๊ถํ์ด ๋ถ์กฑํจ | ์ฌ๋ฐ๋ฅธ CSN์ ํ์ธํ๊ณ , ํ๋ก์ ํธ ์ญ์ ์ ํ์ํ ๊ด๋ฆฌ์ ๊ถํ์ด ์๋์ง ํ์ธํฉ๋๋ค |
PrjGrpPut์ ํ๊ธ/ํน์๋ฌธ์ ๋ช
์นญ์ด ๊นจ์ง๋ค | text ๋ฌธ์์ด์์ ํน์๋ฌธ์๊ฐ ์ด์ค์ผ์ดํ๋์ง ์์ | giipApiSk3์์ jsondata ํ๋ผ๋ฏธํฐ ์นํ ๊ธฐ๋ฅ์ ์ฌ์ฉํด ๋ช
์นญ์ ์ ์ค ์์ด ์ ์กํฉ๋๋ค |
PrjUserMap ํธ์ถ ํ์๋ ์ฌ์ฉ์ ๋ชฉ๋ก์ ๋ณด์ด์ง ์๋๋ค | ๋์ uloginid์ GIIP ๊ณ์ ์ด ์์ง ์์ด ๋งคํ์ด ์คํจํจ(์ด๋ ๋ฉ์ผ๋ง ๋ฐ์ก๋จ) | ๋์์๊ฐ ๋จผ์ GIIP์ ๊ฐ์
ํ ๋ค ๋ค์ PrjUserMap์ ํธ์ถํฉ๋๋ค |
PrjUserPer ํธ์ถ์ด 403์ผ๋ก ๊ฑฐ๋ถ๋๋ค | ํธ์ถ์๊ฐ ํด๋น ํ๋ก์ ํธ Owner(49)๊ฐ ์๋๊ฑฐ๋, ์๊ธฐ ์์ ์ ๋์์ผ๋ก ์ง์ ํจ | Owner ๊ณ์ ์ผ๋ก ํธ์ถํ๊ณ , ๋์์ ์๊ธฐ ์์ ์ด ์๋ ๋ค๋ฅธ ๋ฉค๋ฒ๋ก ์ง์ ํฉ๋๋ค |
๋ฒ์ : 1.4
์ต์ข
์
๋ฐ์ดํธ: 2026-07-26
์์ค ํ์ผ: giipv3/public/help/api-project-user.ko.md
๊ด๋ จ ๋ฌธ์: