๊ด๋ฆฌ์ ๊ธฐ๋ฅ
๊ด๋ฆฌ์ ์ญํ ์ด ๋ถ์ฌ๋ ๊ณ์ ์์๋ง ์ ๊ทผํ ์ ์๋ ๊ธฐ๋ฅ์ ๋๋ค. API ์ค์ , ๋ง์คํฐ DB ๊ด๋ฆฌ, ์ฌ์ฉ์ ๊ด๋ฆฌ, ๋ฐ์ดํฐ ๊ด๋ฆฌ, ํด์ผ ๊ด๋ฆฌ, ํ๋ ๋ก๊ทธ๋ฅผ ํฌํจํฉ๋๋ค.
์ฃผ์: ์ธ์ฆ์ด ๋นํ์ฑํ๋ ํ๊ฒฝ์์๋ ๋ชจ๋ ์ฌ์ฉ์๊ฐ ๊ด๋ฆฌ์ ๊ถํ์ ๊ฐ์ต๋๋ค.
API ์ค์
์ฌ์ด๋๋ฐ ๋๊ตฌ ๊ทธ๋ฃน์ API ์ค์ ์ ํด๋ฆญํ๋ฉด API ์ค์ ๋ค์ด์ผ๋ก๊ทธ๊ฐ ์ด๋ฆฝ๋๋ค. KPIS API ์ฐ๋์ ํ์ํ ์ธ์ฆ ์ ๋ณด๋ฅผ ๋ฑ๋กํ๊ณ ๊ด๋ฆฌํฉ๋๋ค.
๊ณต๋์ธ์ฆ์ ํญ
KPIS API ๋ฑ๋ก(MA111~MA114) ์ ์ ์์๋ช ์ ์ฌ์ฉ๋๋ ๊ณต๋์ธ์ฆ์๋ฅผ ๊ด๋ฆฌํฉ๋๋ค.
| ๊ธฐ๋ฅ | ์ค๋ช |
|---|---|
| ์ธ์ฆ์ ์ ๋ก๋ | DER ํฌ๋งท ์ธ์ฆ์ ํ์ผ์ ์ ๋ก๋ํฉ๋๋ค |
| ๋ง๋ฃ์ผ ์๋ ํ์ฑ | ์ ๋ก๋ ์ ์ธ์ฆ์์์ ๋ง๋ฃ์ผ์ ์๋์ผ๋ก ์ถ์ถํฉ๋๋ค |
| ๋ง๋ฃ ์๋ฐ ๊ฒฝ๊ณ | ๋ง๋ฃ 30์ผ/7์ผ/1์ผ ์ ๋จ๊ณ๋ณ ๊ฒฝ๊ณ ๋ฐฐ๋ ํ์ |
| ์ธ์ฆ์ ์ญ์ | ๊ธฐ์กด ์ธ์ฆ์๋ฅผ ์ญ์ ํฉ๋๋ค |
์ธ์ฆ์๋ ์๋ฒ์ AES-256์ผ๋ก ์ํธํํ์ฌ ๋ณด๊ด๋ฉ๋๋ค.
์ฃผ์: ๊ณต๋์ธ์ฆ์๊ฐ ๋ง๋ฃ๋๋ฉด KPIS API ์๋ ์ ์ถ์ด ๋ถ๊ฐ๋ฅํฉ๋๋ค. ๋ง๋ฃ ์ ์ ๋ฐ๋์ ์ ์ธ์ฆ์๋ฅผ ๋ฑ๋กํ์ธ์. KPIS ์ ์ฉ ๊ณต๋์ธ์ฆ์(์ฉ๋์ ํ)๋ฅผ ์ฌ์ฉํด์ผ ํ๋ฉฐ, ๋ฒ์ฉ ๊ณต๋์ธ์ฆ์๋ ์ฌ์ฉํ ์ ์์ต๋๋ค.
DEV API ํญ
๊ฐ๋ฐ/ํ ์คํธ ํ๊ฒฝ์ฉ KPIS API ์ค์ ์ ๋๋ค.
| ์ค์ ํญ๋ชฉ | ์ค๋ช |
|---|---|
| ์ฌ์ ์๋ฑ๋ก๋ฒํธ | ๊ฐ๋ฐ์ฉ ์ฌ์ ์๋ฑ๋ก๋ฒํธ (10์๋ฆฌ, ํ์ดํ ์์ด ์ซ์๋ง) |
| API KEY | KPIS ๊ฐ๋ฐ ํฌํธ์์ ๋ฐ๊ธ๋ฐ์ API ํค |
| ์ฐ๊ฒฐ ํ ์คํธ | ์ค์ ๋ ์ ๋ณด๋ก KPIS ๊ฐ๋ฐ ์๋ฒ ์ฐ๊ฒฐ์ ํ ์คํธํฉ๋๋ค |
์ฐ๊ฒฐ ํ ์คํธ ์ฑ๊ณต ์ ์ด๋ก์ ์ ์ด ํ์๋ฉ๋๋ค.
LIVE API ํญ
์ด์ ํ๊ฒฝ์ฉ KPIS API ์ค์ ์ ๋๋ค. DEV API ํญ๊ณผ ๋์ผํ ๊ตฌ์กฐ์ด๋ฉฐ, ์ด์์ฉ ์ฌ์ ์๋ฑ๋ก๋ฒํธ์ API KEY๋ฅผ ๋ฑ๋กํฉ๋๋ค.
์ฃผ์: LIVE ํ๊ฒฝ์ API KEY๋ก ์ ์ถํ๋ฉด ์ค์ KPIS์ ๋ณด๊ณ ๋ฉ๋๋ค. ํ ์คํธ ๋ฐ์ดํฐ๋ฅผ LIVE ํ๊ฒฝ์ ์ ์ถํ์ง ์๋๋ก ์ฃผ์ํ์ธ์.
DEV/LIVE ํ๊ฒฝ ์ ํ
์ฌ์ด๋๋ฐ ํ๋จ์ DEV/LIVE ๋ฐฐ์ง๋ฅผ ํด๋ฆญํ์ฌ ํ๊ฒฝ์ ์ ํํ ์ ์์ต๋๋ค.
| ํ๊ฒฝ | ๋์ ์๋ฒ | ์ฉ๋ |
|---|---|---|
| DEV | devopenapi.kpis.or.kr | ๊ฐ๋ฐ/ํ ์คํธ โ ์ ์ถํด๋ ์ค์ ๋ฐ์๋์ง ์์ |
| LIVE | openapi.kpis.or.kr | ์ด์ โ ์ ์ถํ๋ฉด ์ค์ KPIS์ ๋ณด๊ณ ๋จ |
LIVE ๋ชจ๋๋ก ์ ํ ์ ๊ฒฝ๊ณ ๋ค์ด์ผ๋ก๊ทธ๊ฐ ํ์๋๋ฉฐ, ์ฌ์ด๋๋ฐ ์๋จ์ ๋นจ๊ฐ์ โLIVE ์ด์ ์๋ฒโ ๊ฒฝ๊ณ ์คํธ๋ผ์ดํ๊ฐ ํ์๋ฉ๋๋ค.
์ฃผ์: DEV ํค๋ก LIVE ์๋ฒ๋ฅผ ํธ์ถํ๊ฑฐ๋ ๊ทธ ๋ฐ๋๋ ์ธ์ฆ ์ค๋ฅ๊ฐ ๋ฐ์ํฉ๋๋ค. ํ๊ฒฝ ์ ํ ์ ๋ฐ๋์ ํด๋น ํ๊ฒฝ์ API KEY๊ฐ ๋ฑ๋ก๋์ด ์๋์ง ํ์ธํ์ธ์.
๋ง์คํฐ DB ๊ด๋ฆฌ
์ฌ์ด๋๋ฐ ๋๊ตฌ ๊ทธ๋ฃน์ ๋ง์คํฐ DB๋ฅผ ํด๋ฆญํ๋ฉด ๋ง์คํฐ ๋ฐ์ดํฐ ๊ด๋ฆฌ ๋ค์ด์ผ๋ก๊ทธ๊ฐ ์ด๋ฆฝ๋๋ค. ํ์ค์ฝ๋ ๋งค์นญ, ๊ท๊ฒฉ ๊ฒ์ฆ, ์ฝ๋๊ฒ์์ ์ฌ์ฉ๋๋ ๊ธฐ์ค ๋ฐ์ดํฐ๋ฅผ ๊ด๋ฆฌํฉ๋๋ค.
ํ์ค์ฝ๋ ๋ง์คํฐ
KPIS 13์๋ฆฌ ์์ฝํ ์๋ณ์ฝ๋ ๋ฐ์ดํฐ์ ๋๋ค. ๋ ๊ฐ์ง ๋ฐฉ๋ฒ์ผ๋ก ๋ฑ๋กํ ์ ์์ต๋๋ค.
๋ฐฉ๋ฒ 1: KPIS API ์กฐํ (MA101)
- ๋ง์คํฐ DB ํจ๋์์ API ์กฐํ ๋ฒํผ์ ํด๋ฆญํฉ๋๋ค.
- KPIS MA101 API๋ฅผ ํธ์ถํ์ฌ ์ต์ ํ์ค์ฝ๋ ๋ฐ์ดํฐ๋ฅผ ๊ฐ์ ธ์ต๋๋ค.
- ๊ธฐ์กด ๋ฐ์ดํฐ์ ๋ณํฉ๋ฉ๋๋ค.
๋ฐฉ๋ฒ 2: ์์ ์ ๋ก๋
- ๋ง์คํฐ DB ํจ๋์์ ์์ ์ ๋ก๋ ๋ฒํผ์ ํด๋ฆญํฉ๋๋ค.
- ํ์ค์ฝ๋๋ง์คํฐ ์์ ํ์ผ์ ์ ํํฉ๋๋ค.
- ํ์ผ์ ๋ฐ์ดํฐ๊ฐ ๋ง์คํฐ DB์ ๋ฑ๋ก๋ฉ๋๋ค.
๋ฐ์ฝ๋ ๋ฐ์ดํฐ
BarCodeData ์์ ์ ์ ๋ก๋ํ์ฌ ๊ท๊ฒฉ, ์ ์ฒด๋ช , ์ ํ ๋ฑ ์ถ๊ฐ ์ ๋ณด๋ฅผ ๋ฑ๋กํฉ๋๋ค. ๋ฐ์ฝ๋ ๋ฐ์ดํฐ๋ ์๋ ์ฝ๋๋งคํ์ ํํฐ ์ฒด์ธ์์ ์ ํ๊ตฌ๋ถ, ํฌ์ฅ์๋ ๋ฑ์ ๋น๊ต์ ํ์ฉ๋ฉ๋๋ค.
๊ฒ์
๋ฑ๋ก๋ ๋ง์คํฐ ๋ฐ์ดํฐ๋ฅผ ์ ํ๋ช ๋๋ ํ์ค์ฝ๋๋ก ๊ฒ์ํ ์ ์์ต๋๋ค. ๊ฒ์ ๊ฒฐ๊ณผ์์ ๊ฐ ์ ํ์ ํฌ์ฅ์๋, ์ํ๊ฐ, ๊ท๊ฒฉ, ์ ํ ๋ฑ์ ์์ธ ์ ๋ณด๋ฅผ ํ์ธํ ์ ์์ต๋๋ค.
์ฃผ์: ๋ง์คํฐ DB๊ฐ ๋น์ด์๊ฑฐ๋ ์ค๋๋ ๋ฐ์ดํฐ๋ง ์์ผ๋ฉด ์๋ ์ฝ๋๋งคํ์ ๋งค์นญ๋ฅ ์ด ํฌ๊ฒ ๋จ์ด์ง๋๋ค. ๋ถ๊ธฐ ๋ณด๊ณ ์์ ์ ์ ์ต์ ๋ฐ์ดํฐ๋ก ์ ๋ฐ์ดํธํ๋ ๊ฒ์ ๊ถ์ฅํฉ๋๋ค.
์ฌ์ฉ์ ๊ด๋ฆฌ
์ฌ์ด๋๋ฐ ๋๊ตฌ ๊ทธ๋ฃน์ ์ฌ์ฉ์๊ด๋ฆฌ๋ฅผ ํด๋ฆญํ๋ฉด ์ฌ์ฉ์ ๊ด๋ฆฌ ๋ค์ด์ผ๋ก๊ทธ๊ฐ ์ด๋ฆฝ๋๋ค. Google OAuth ์ธ์ฆ์ด ํ์ฑํ๋ ํ๊ฒฝ์์๋ง ํ์๋ฉ๋๋ค.
์ฌ์ฉ์ ๋ชฉ๋ก
๋ฑ๋ก๋ ๋ชจ๋ ์ฌ์ฉ์๊ฐ ๋ชฉ๋ก์ผ๋ก ํ์๋ฉ๋๋ค. ๊ฐ ์ฌ์ฉ์์ ์ด๋ฉ์ผ, ์ญํ , ์น์ธ ์ํ๋ฅผ ํ์ธํ ์ ์์ต๋๋ค.
๊ด๋ฆฌ ๊ธฐ๋ฅ
| ๋์ | ์ค๋ช |
|---|---|
| ์น์ธ | ๋๊ธฐ ์ค์ธ ์ฌ์ฉ์์๊ฒ ์ ๊ทผ ๊ถํ์ ๋ถ์ฌํฉ๋๋ค |
| ์น์ธ ์ทจ์ | ๊ธฐ์กด ์ฌ์ฉ์์ ์ ๊ทผ ๊ถํ์ ํ์ํฉ๋๋ค |
| ์ญ์ | ์ฌ์ฉ์ ๊ณ์ ์ ์์ ํ ์ญ์ ํฉ๋๋ค (๋ณต๊ตฌ ๋ถ๊ฐ) |
| ์ญํ ๋ณ๊ฒฝ | ์ฌ์ฉ์๋ฅผ ๊ด๋ฆฌ์(admin) ๋๋ ์ผ๋ฐ(user) ์ญํ ๋ก ๋ณ๊ฒฝํฉ๋๋ค |
์ฃผ์: ์ต์ด ๊ฐ์ ์๋ ์๋์ผ๋ก ๊ด๋ฆฌ์ ์ญํ ์ด ๋ถ์ฌ๋ฉ๋๋ค. ๊ด๋ฆฌ์๊ฐ ์ต์ 1๋ช ์ ์ ์ง๋์ด์ผ ํฉ๋๋ค.
๋ฐ์ดํฐ ๊ด๋ฆฌ
์ฌ์ด๋๋ฐ ๋๊ตฌ ๊ทธ๋ฃน์ ๋ฐ์ดํฐ ๊ด๋ฆฌ๋ฅผ ํด๋ฆญํ๋ฉด ๊ด๋ฆฌ ํ๋ฉด(AdminView)์ผ๋ก ์ด๋ํฉ๋๋ค.
๋ ์ง๋ณ ๋ฐ์ดํฐ ์ง๊ณ
๋ ์ง๋ณ๋ก ์ ๋ก๋๋ ๋ฐ์ดํฐ์ ์์ฝ ์ ๋ณด๊ฐ ํ ์ด๋ธ๋ก ํ์๋ฉ๋๋ค.
| ์ด | ์ค๋ช |
|---|---|
| ๋ ์ง | YYYY-MM-DD ํ์ |
| ๊ฐ์ง | ๊ฐ์ง ์ ์ฒด ํ ์ |
| ์์ง | ์์ง ์ ์ฒด ํ ์ |
| ๋ณด๊ณ | KPIS์ ์ ์ถ ์๋ฃ๋ ๊ฑด์ |
| ๋ฏธ๋ณด๊ณ | ์์ง ์ ์ถํ์ง ์์ ๊ฑด์ |
| ์ํ | ๋ณด๊ณ ์๋ฃ / ๋ถ๋ถ๋ณด๊ณ / ์ ๋ก๋๋ง / ์ค๋ฅ ๋ฐฐ์ง ํ์ |
๊ด๋ฆฌ ๊ธฐ๋ฅ
| ๋์ | ์ค๋ช |
|---|---|
| ํ ํด๋ฆญ | ํด๋น ๋ ์ง์ ๋ฐ์ดํฐ๋ฅผ DataGrid์ ๋ก๋ํฉ๋๋ค |
| ์ํ ์ด๊ธฐํ | ์ ์๋ฒํธ, ์ ์ถ์ํ, ์ค๋ฅ๋ฅผ ๋ชจ๋ ์ด๊ธฐํํฉ๋๋ค. ๋ฐ์ดํฐ๋ฅผ ์ฌ๋ณด๊ณ ๊ฐ๋ฅํ ์ํ๋ก ๋๋๋ฆฝ๋๋ค |
| ์ญ์ | ํด๋น ๋ ์ง์ ๊ฐ์ง/์์ง ๋ฐ์ดํฐ๋ฅผ ์์ ํ ์ญ์ ํฉ๋๋ค |
์ฃผ์: ์ญ์ ๋ ๋ณต๊ตฌํ ์ ์์ต๋๋ค. ์ด๋ฏธ KPIS์ ์ ์ถํ ๊ฑด์ด ํฌํจ๋ ๋ ์ง๋ฅผ ์ญ์ ํ๋๋ผ๋ KPIS ์๋ฒ์ ๋ณด๊ณ ๋ด์ญ์ ์ ์ง๋ฉ๋๋ค. KPIS ๋ณด๊ณ ๋ฅผ ์ทจ์ํ๋ ค๋ฉด ์ญ์ ๊ฐ ์๋ ์ทจ์(์ฝ๋ 5) ์ ์ถ์ด ํ์ํฉ๋๋ค.
ํด์ผ ๊ด๋ฆฌ
์ฌ์ด๋๋ฐ ๋๊ตฌ ๊ทธ๋ฃน์ ํด์ผ ๊ด๋ฆฌ๋ฅผ ํด๋ฆญํ๋ฉด ํด์ผ ๊ด๋ฆฌ ๋ค์ด์ผ๋ก๊ทธ๊ฐ ์ด๋ฆฝ๋๋ค.
๊ธฐ๋ฅ
| ๊ธฐ๋ฅ | ์ค๋ช |
|---|---|
| ๊ณตํด์ผ ์๋ ์์ง | ๊ณต๊ณต๋ฐ์ดํฐํฌํธ API๋ฅผ ํตํด ๋ฒ์ ๊ณตํด์ผ ๋ฐ์ดํฐ๋ฅผ ์๋์ผ๋ก ๊ฐ์ ธ์ต๋๋ค |
| ํ์ฌ ํด์ผ ์ค์ | ํ์ฌ ์์ฒด ํด๋ฌด์ผ์ ์๋์ผ๋ก ์ถ๊ฐํฉ๋๋ค |
| ํด์ผ ์ญ์ | ๋ฑ๋ก๋ ํด์ผ์ ์ญ์ ํฉ๋๋ค |
ํ์ฉ
- ๋ฌ๋ ฅ์ ๋ ์ง ์์ ์ ์ ์์ ์ผ/ํด์ผ ๊ตฌ๋ถ์ด ๋ฐ์๋ฉ๋๋ค.
- ๋ฏธ๋ณด๊ณ ๋ ์ง ๋ฐฐ๋์์ ํด์ผ์ ์๋์ผ๋ก ์ ์ธ๋ฉ๋๋ค.
- ๋ณด๊ณ ์จ ๊ณ์ฐ์์ ํด์ผ์ ์ ์ธ๋ฉ๋๋ค.
ํ๋ ๋ก๊ทธ
์๋จ ํค๋์ ํ๋ ๋ก๊ทธ ๋ฒํผ(๋ฒจ ์์ด์ฝ)์ ํด๋ฆญํ๋ฉด ํ๋ ๋ก๊ทธ ๋ค์ด์ผ๋ก๊ทธ๊ฐ ์ด๋ฆฝ๋๋ค.
๊ธฐ๋ก๋๋ ํ๋
์์คํ ์ ์ฃผ์ ํ๋์ด ์๋์ผ๋ก ๊ธฐ๋ก๋ฉ๋๋ค.
| ํ๋ ์ ํ | ์์ |
|---|---|
| ๋ฐ์ดํฐ ์ ๋ก๋ | โ2026-03-08 ๊ฐ์ง 150๊ฑด ์ ๋ก๋โ |
| ์๋์ฒ๋ฆฌ | โ์ฝ๋๋งคํ 45๊ฑด, ๊ท์น 12๊ฑด ์ ์ฉโ |
| API ์ ์ถ | โMA111 ์ถ๊ณ 120๊ฑด ์ ์ถ ์๋ฃโ |
| ๊ฒฐ๊ณผํ์ธ | โMA112 118๊ฑด ๋ฑ๋ก, 2๊ฑด ๋ฐ์กโ |
| ๋ฐ์ดํฐ ์ญ์ | โ2026-03-08 ๋ฐ์ดํฐ ์ญ์ โ |
| ๋ง์คํฐ ์ ๋ฐ์ดํธ | โํ์ค์ฝ๋๋ง์คํฐ 1,885๊ฑด ๋ฑ๋กโ |
| ํ๊ฒฝ ์ ํ | โAPI ํ๊ฒฝ DEV โ LIVE ์ ํโ |
ํ๋ ๋ก๊ทธ๋ ์๊ฐ์์ผ๋ก ์ ๋ ฌ๋๋ฉฐ, ๊ฐ ํญ๋ชฉ์ ๋ฐ์ ์๊ฐ๊ณผ ์์ธ ๋ด์ฉ์ด ํ์๋ฉ๋๋ค.
๋ค์ ๋จ๊ณ
- ์์ํ๊ธฐ โ ์์คํ ๊ฐ์ ๋ฐ ํ๋ฉด ๊ตฌ์ฑ
- ๋ด๋ณด๋ด๊ธฐ ๋ฐ ์ ์ถ โ API ์ค์ ํ ์ ์ถ ์ ์ฐจ
- ๋ฐ์ก ๊ด๋ฆฌ โ ๋ฐ์ก ๊ฑด ์ฒ๋ฆฌ