Versions Compared

Version Old Version 4 New Version Current
Changes made by

Hannah

Hannah

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ICE의 API 유형은 다음과 같이 구분한다.

service

  • FrontOffice에서 사용하는 API

  • Path : svc

Info

{{protocol}}://{{hostname}}:{{port}}/svc/{{apiCategory}}/{{api}}

  • 인증 : siteId가 항상 포함되어 있으며, Customer의 세션을 사용한다.

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

GET {{protocol}}://{{hostname}}:{{port}}/auth/adm/jwt

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 사용자만 사용 가능

...

ICE의 API 유형은 다음과 같이 구분한다.

▪ service

  • FrontOffice에서 사용하는 API

  • Path : svc

Info

{{protocol}}://{{hostname}}:{{port}}/auth/mng/jwt

Note
Info

POST svc/{{protocolapiCategory}}://{{hostname}}:{{port}}/mng/signIn

external

  • 외부 또는 레거시 시스템과 연동을 위해서 사용하는 API

  • Path : ext

api}}?_siteId=dxp

  • _siteId 항상 필수

  • 자동 생성 API 사용 불가능. 설정 API 만 사용 가능.

  • 인증 : Customer의 세션을 사용한다.

Note

GET {{protocol}}://{{hostname}}:{{port}}/ext/{{nodeType}}/{{event}}auth/svc/jwt?_siteId=dxp

▪ admin

  • Admin 사용자용 BackOffice를 위한 API

  • Path : adm

Info

{{protocol}}://{{hostname}}:{{port}}/extadm/{{apiCategorynodeType}}/{{apievent}}

  • 인증 : API 키를 통해서 인증

internal

  • ICE 내부 서비스간 연동을 위해서 사용하는 API

  • Path : int

Infoinfo

{{protocol}}://{{hostname}}:{{port}}/intadm/{{nodeTypeapiCategory}}/{{eventapi}}

Info

  • 인증 : 반드시 로그인된 Admin 사용자만 사용 가능

Note

GET {{protocol}}://{{hostname}}:{{port}}/auth/intadm/jwt

Note

POST {{apiCategoryprotocol}}://{{apihostname}}

  • 인증 : 클러스터에 등록된 서버들만 통신 가능

open

...

:{{port}}/adm/signIn

▪ manager

  • Manger 사용자용 BackOffice를 위한 API

  • Path : api mng

Info

{{protocol}}://{{hostname}}:{{port}}/apimng/{{nodeType}}/{{event}}

Info

{{protocol}}://{{hostname}}:{{port}}/apimng/{{apiCategory}}/{{api}}

  • 인증 : API Key를 이용한 인증 사용, 요구사항에 따라서 인증 방식 확장이 가능(OAuth 등)

...

  • 반드시 로그인된 Manager 사용자만 사용 가능

apitestEventlist
Note

GET {{protocol}}://{{hostname}}:{{port}}/

auth/

mng/

jwt

code
{{
Note
{
    "timestamp": "2020-10-20T02:45:39.969+0000",
    "status": 400,
    "error": "Bad Request",
    "message": "Required String parameter 'apiKey' is not present",
    "path": "/api/testEvent/list"
}
Expand
title

POST {{protocol}}://{{hostname}}:{{port}}/mng/signIn

▪ external

  • 외부 또는 레거시 시스템과 연동을 위해서 사용하는 API

  • Path : ext

Info

{{protocol}}://{{hostname}}:{{port}}/ext/{{nodeType}}/{{event}}

api/testEvent/list?apiKey=W2!G*LgUu?5*!c*VubLVsfVyW42t$KHt
Info

{{protocol}}://{{hostname}}:{{port}}/

Code Block
{
    "result": "200",
    "resultMessage": "SUCCESS",
    "totalCount": 0,
    "totalTypeCount": 0,
    "resultCount": 0,
    "items": []
}

apiType은 apiCategory 와 api 에 각각 설정 가능하다.

...

apiCategory 설정되어있고 api에 설정 안되어있으면 하위 api 는 apiCategory의 apiType을 따라간다.

...

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 사용 불가능. 설정 API 만 사용 가능.

  • 인증 : API Key를 이용한 인증 사용, 요구사항에 따라서 인증 방식 확장이 가능(OAuth 등)

Expand
title{{protocol}}://{{hostname}}:{{port}}/api/testEvent/list
Code Block
{
    "timestamp": "2020-10-20T02:45:39.969+0000",
    "status": 400,
    "error": "Bad Request",
    "message": "Required String parameter 'apiKey' is not present",
    "path": "/api/testEvent/list"
}
Expand
title{{protocol}}://{{hostname}}:{{port}}/api/testEvent/list?apiKey=W2!G*LgUu?5*!c*VubLVsfVyW42t$KHt
Code Block
{
    "result": "200",
    "resultMessage": "SUCCESS",
    "totalCount": 0,
    "totalTypeCount": 0,
    "resultCount": 0,
    "items": []
}

apiType은 apiCategory 와 api 에 각각 설정 가능하다.

  • apiCategory 설정되어있고 api에 설정 안되어있으면 하위 api 는 apiCategory의 apiType을 따른다.

  • apiCategory와 하위 api에 서로다른 apiType이 설정되어 있는 경우 api 는 자신의 apiType을 따른다.

Expand
title[apiCategory] apiType : null, [api] apiType : service
Code Block
languagejson
{
  "typeId": "apiCategory",
  "id": "product",
  "categoryName": "product API",
  "dateFormat": "yyyy-MM-dd HH:mm:ss",
  "fileUrlFormat": {
    "default": "{{:getEnvValue('core.cluster.api-url-prefix')}}"
  },
  "commonParameters": [
  ],
  "commonResponse": [
  ]
}
Code Block
{
  "typeId": "api",
  "category": "product",
  "apiId": "list",
  "apiName": "Product List",
  "apiType": "service",
  "method": "GET",
  "parameters": [
  ],
  "config": {
    ...
  }
}
Info

{{protocol}}://{{hostname}}:{{port}}/svc/product/list?_siteId=dxp

Expand
title[apiCategory] apiType : service, [api] apiType : null
Code Block
languagejson
{
  "typeId": "apiCategory",
  "id": "product",
  "categoryName": "product API",
  "apiType": "service",
  "dateFormat": "yyyy-MM-dd HH:mm:ss",
  "fileUrlFormat": {
    "default": "{{:getEnvValue('core.cluster.api-url-prefix')}}"
  },
  "commonParameters": [
  ],
  "commonResponse": [
  ]
}
Code Block
languagejson
{
  "typeId": "api",
  "category": "product",
  "apiId": "list",
  "apiName": "Product List",
  "apiType": "",
  "method": "GET",
  "parameters": [
  ],
  "config": {
    ...
  }
}
Info

{{protocol}}://{{hostname}}:{{port}}/svc/product/list?_siteId=dxp

Expand
title[apiCategory] apiType : service, [api] apiType : admin
Code Block
languagejson
{
  "typeId": "apiCategory",
  "id": "product",
  "categoryName": "product API",
  "apiType": "service",
  "dateFormat": "yyyy-MM-dd HH:mm:ss",
  "fileUrlFormat": {
    "default": "{{:getEnvValue('core.cluster.api-url-prefix')}}"
  },
  "commonParameters": [
  ],
  "commonResponse": [
  ]
}
Code Block
languagejson
{
  "typeId": "api",
  "category": "product",
  "apiId": "list",
  "apiName": "Product List",
  "apiType": "admin",
  "method": "GET",
  "parameters": [
  ],
  "config": {
    ...
  }
}
Info

{{protocol}}://{{hostname}}:{{port}}/adm/product/list