ICE의 API 유형은 다음과 같이 구분한다.
...
Service
FrontOffice에서 사용하는 API
Path : svc
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/svc/{{apiCategory}}/{{api}}?_siteId=dxp |
| Note |
|---|
GET {{protocol}}://{{hostname}}:{{port}}/auth/svc/jwt?_siteId=dxp |
...
Admin
Admin 사용자용 BackOffice를 위한 API
Path : adm
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/adm/{{nodeType}}/{{event}} |
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/adm/{{apiCategory}}/{{api}} |
인증 : 반드시 로그인된 Admin 사용자만 사용 가능
...
| Note |
|---|
POST {{protocol}}://{{hostname}}:{{port}}/adm/signIn |
...
Manager
Manger 사용자용 BackOffice를 위한 API
Path : mng
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/mng/{{nodeType}}/{{event}} |
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/mng/{{apiCategory}}/{{api}} |
인증 : 반드시 로그인된 Manager 사용자만 사용 가능
...
| Note |
|---|
POST {{protocol}}://{{hostname}}:{{port}}/mng/signIn |
...
External
외부 또는 레거시 시스템과 연동을 위해서 사용하는 API
Path : ext
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/ext/{{nodeType}}/{{event}} |
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/ext/{{apiCategory}}/{{api}} |
인증 : API 키를 통해서 인증
...
Internal
ICE 내부 서비스간 연동을 위해서 사용하는 API
Path : int
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/int/{{nodeType}}/{{event}} |
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/int/{{apiCategory}}/{{api}} |
인증 : 클러스터에 등록된 서버들만 통신 가능
...
Open
오픈 API에 사용
Path : api
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/api/{{nodeType}}/{{event}} |
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/api/{{apiCategory}}/{{api}} |
인증 : API Key를 이용한 인증 사용, 요구사항에 따라서 인증 방식 확장이 가능(OAuth 등)
...