Open Api 관리

인증키 등록/수정

post

기능설명

인증키 등록/수정 합니다.

상세설명

인증키 등록/수정은 PO에서만 가능합니다.
협력사번호/협력사명은 진입 계정의 협력사 정보 자동 출력, 임의 수정 불가합니다.
등록
- 이미 사용 여부가 'Y'인 인증키가 3개인 경우 인증키 등록은 사용여부 'N'으로만 등록이 가능합니다.
- 유효기간 : 시작일자는 Today(default) , 종료일자는 Today + 365일(default)
- 서버IP : 직접 입력(숫자, 특수문자만 입력 가능), 쉼표(,)로 IP 구분, 최대 1000 byte 입력 가능(초과 시 입력 불가)
수정
- 이미 3개의 인증키를 사용 중인 협력사를 포함하여 사용 여부를 'N' 에서 'Y'로 변경할 경우 변경이 불가합니다.
- 유효 기간이 종료된 인증키는 수정 불가 > 취소/저장 버튼 비노출 , 닫기 버튼 노출

수정번호

Release v2.00_240826: 신규 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

인증키 Update Request

sysRegIdstringOptional

sysModIdstringOptional

certiKeystringOptional

인증키번호

useYnstringOptional

사용여부

entrNostringOptional

협력사 번호

valiStartDtmstring · date-timeOptional

유효기간시작일시

valiEndDtmstring · date-timeOptional

유효기간종료일시

svrIpstringOptional

서버IP

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/system/openApiMgmt/updateCertificationKey

POST /api/bo/v1/system/openApiMgmt/updateCertificationKey HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "sysRegId": "text",
  "sysModId": "text",
  "certiKey": "text",
  "useYn": "text",
  "entrNo": "text",
  "valiStartDtm": "2026-01-01T00:00:00.000Z",
  "valiEndDtm": "2026-01-01T00:00:00.000Z",
  "svrIp": "text"
}

No content

인증키 사용여부 수정

post

기능설명

인증키 사용여부를 수정합니다.

상세설명

기존 3개의 인증키를 사용 중인 협력사의 사용 여부를 N 에서 Y로 변경할 경우 변경이 불가합니다.

수정번호

Release v2.00_240826: 신규 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · CertificationKeyValidationResponse[]

인증키 목록 수정 Validation Response

entrNostringOptional

협력사 번호

entrNmstringOptional

협력사 명

certiKeystringOptional

인증키

useYnstringOptional

사용여부

updateYnbooleanOptional

업데이트 가능여부

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/system/openApiMgmt/saveOptionList

POST /api/bo/v1/system/openApiMgmt/saveOptionList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

[
  {
    "entrNo": "text",
    "entrNm": "text",
    "certiKey": "text",
    "useYn": "text",
    "updateYn": true
  }
]

No content

OpenAPI 등록/수정

post

기능설명

OpenAPI 등록, 수정합니다.

상세설명

OpenAPI에 대한 API명, 업무영역, API URL, 메이저버전, 마이너버전, 사용여부를 수정합니다.

수정번호

Release v2.00_240826: 신규 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v1/system/openApiMgmt/saveOpenApiList

POST /api/bo/v1/system/openApiMgmt/saveOpenApiList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 614

{
  "all": [
    {
      "openApiNo": 1,
      "mjrVer": 1,
      "mnrVer": 0,
      "jobAreaGbCd": 10,
      "openApiNm": "상품등록API",
      "openApiUrl": "/api/intf/v1/goods/search/list",
      "useYn": "Y"
    }
  ],
  "create": [
    {
      "openApiNo": 1,
      "mjrVer": 1,
      "mnrVer": 0,
      "jobAreaGbCd": 10,
      "openApiNm": "상품등록API",
      "openApiUrl": "/api/intf/v1/goods/search/list",
      "useYn": "Y"
    }
  ],
  "update": [
    {
      "openApiNo": 1,
      "mjrVer": 1,
      "mnrVer": 0,
      "jobAreaGbCd": 10,
      "openApiNm": "상품등록API",
      "openApiUrl": "/api/intf/v1/goods/search/list",
      "useYn": "Y"
    }
  ],
  "delete": [
    {
      "openApiNo": 1,
      "mjrVer": 1,
      "mnrVer": 0,
      "jobAreaGbCd": 10,
      "openApiNm": "상품등록API",
      "openApiUrl": "/api/intf/v1/goods/search/list",
      "useYn": "Y"
    }
  ]
}

text

인증키 사용여부 수정 가능 조회

post

기능설명

인증키 사용여부 수정 가능여부를 조회합니다.

상세설명

이미 3개의 인증키를 사용 중인 협력사를 포함하는지 조회합니다.
유효기간 유효한 것 + 사용여부 Y인 인증키가 3개 이하인지 확인합니다.
업데이트 가능여부(updateYn) : boolean값으로 true, false

수정번호

Release v2.00_240826: 신규 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · CertificationKeyResponse[]

인증키 목록 Response

entrNostringOptional

협력사 번호

entrNmstringOptional

협력사명

caloSvrIpAddrstringOptional

서버IP

certiKeystringOptional

인증키

issuDtstringOptional

발급일자

valiStrDtmstring · date-timeOptional

유효시작일자

valiEndDtmstring · date-timeOptional

유효종료일자

lastCallDtstring · date-timeOptional

마지막호출일시

useYnstringOptional

사용여부

Responses

200

성공

*/*

인증키 목록 수정 Validation Response

entrNostringOptional

협력사 번호

entrNmstringOptional

협력사 명

certiKeystringOptional

인증키

useYnstringOptional

사용여부

updateYnbooleanOptional

업데이트 가능여부

900

업무처리 오류 내용

*/*

post/v1/system/openApiMgmt/getSaveOptionValidationList

POST /api/bo/v1/system/openApiMgmt/getSaveOptionValidationList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 227

[
  {
    "entrNo": "text",
    "entrNm": "text",
    "caloSvrIpAddr": "text",
    "certiKey": "text",
    "issuDt": "text",
    "valiStrDtm": "2026-01-01T00:00:00.000Z",
    "valiEndDtm": "2026-01-01T00:00:00.000Z",
    "lastCallDt": "2026-01-01T00:00:00.000Z",
    "useYn": "text"
  }
]

[
  {
    "entrNo": "text",
    "entrNm": "text",
    "certiKey": "text",
    "useYn": "text",
    "updateYn": true
  }
]

인증키 목록 조회

post

기능설명

인증키 목록을 조회합니다.

상세설명

조회기준 : 발급일자, 유효기간 시작일자, 유효기간 종료일자
조회기준날짜 : 최근3일, 최근7일, 최근30일(default), 전체
서버 IP : 직접입력(숫자, 특수문자만 입렵 가능), 텍스트(한글, 영문) 입력 불가

수정번호

Release v2.00_240826: 신규 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

인증키 목록 Request

entrNostringOptional

협력사 번호

termGbCdstringOptional

조회기준

searchStartDtstring · dateOptional

조회시작일자

searchEndDtstring · dateOptional

조회끝일자

useYnstringOptional

사용여부

certiKeystringOptional

인증키

svrIpstringOptional

서버IP

dateSelectstringOptional

조회기준날짜

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

post/v1/system/openApiMgmt/getCertificationKeyList

POST /api/bo/v1/system/openApiMgmt/getCertificationKeyList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "entrNo": "text",
  "termGbCd": "text",
  "searchStartDt": "2026-01-01",
  "searchEndDt": "2026-01-01",
  "useYn": "text",
  "certiKey": "text",
  "svrIp": "text",
  "dateSelect": "text"
}

{
  "totalCount": 1,
  "payloads": [
    {
      "entrNo": "text",
      "entrNm": "text",
      "caloSvrIpAddr": "text",
      "certiKey": "text",
      "issuDt": "text",
      "valiStrDtm": "2026-01-01T00:00:00.000Z",
      "valiEndDtm": "2026-01-01T00:00:00.000Z",
      "lastCallDt": "2026-01-01T00:00:00.000Z",
      "useYn": "text"
    }
  ]
}

인증키 목록 조회

post

기능설명

인증키 정보를 조회합니다.

상세설명

인증키 정보(단건)를 조회합니다.

수정번호

Release v2.00_240826: 신규 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

인증키 목록 Request

entrNostringOptional

협력사 번호

termGbCdstringOptional

조회기준

searchStartDtstring · dateOptional

조회시작일자

searchEndDtstring · dateOptional

조회끝일자

useYnstringOptional

사용여부

certiKeystringOptional

인증키

svrIpstringOptional

서버IP

dateSelectstringOptional

조회기준날짜

Responses

200

성공

*/*

인증키 목록 Response

entrNostringOptional

협력사 번호

entrNmstringOptional

협력사명

caloSvrIpAddrstringOptional

서버IP

certiKeystringOptional

인증키

issuDtstringOptional

발급일자

valiStrDtmstring · date-timeOptional

유효시작일자

valiEndDtmstring · date-timeOptional

유효종료일자

lastCallDtstring · date-timeOptional

마지막호출일시

useYnstringOptional

사용여부

900

업무처리 오류 내용

*/*

post/v1/system/openApiMgmt/getCertificationKeyInfo

POST /api/bo/v1/system/openApiMgmt/getCertificationKeyInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "entrNo": "text",
  "termGbCd": "text",
  "searchStartDt": "2026-01-01",
  "searchEndDt": "2026-01-01",
  "useYn": "text",
  "certiKey": "text",
  "svrIp": "text",
  "dateSelect": "text"
}

{
  "entrNo": "text",
  "entrNm": "text",
  "caloSvrIpAddr": "text",
  "certiKey": "text",
  "issuDt": "text",
  "valiStrDtm": "2026-01-01T00:00:00.000Z",
  "valiEndDtm": "2026-01-01T00:00:00.000Z",
  "lastCallDt": "2026-01-01T00:00:00.000Z",
  "useYn": "text"
}

Open API 목록 조회

get

기능설명

화면에서 넘어온 등록일시, 메이저버전, 업무영역, 사용여부, API명, API URL 구분에 맞는 OpenAPI 목록을 조회합니다.

상세설명

화면에서 넘어온 등록일시, 메이저버전, 업무영역, 사용여부, API명, API URL 구분에 맞는 OpenAPI 목록을 조회합니다.

수정번호

Release v2.00_240826: 신규 개발

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageIdxStringRequired

현재 페이지

Example: 1

rowsPerPageStringRequired

페이지 당 row

Example: 10

Responses

200

성공

*/*

Open Api 목록 조회 응답 DTO

totalCntinteger · int32Optional

총 건수

jobAreaGbCdstringOptional

업무영역구분코드

Example: 상품

openApiNostringOptional

API 번호

Example: 1

openApiNmstringOptional

API 명

Example: 상품등록API

openApiUrlstringOptional

API URL

Example: /api/intf/v1/goods/register/goods

mjrVerstringOptional

메이저버전

Example: 1

mnrVerstringOptional

마이너버전

Example: 00

useYnstringOptional

사용여부

Example: Y

sysRegIdstringOptional

시스템등록ID

sysRegDtmstring · date-timeOptional

시스템등록일시

sysModIdstringOptional

시스템수정ID

sysModDtmstring · date-timeOptional

시스템수정일시

900

업무처리 오류 내용

*/*

get/v1/system/openApiMgmt/getOpenApiList

GET /api/bo/v1/system/openApiMgmt/getOpenApiList?openApiInfoRequest=[object+Object]&pageIdx=null&rowsPerPage=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "totalCnt": 1,
    "jobAreaGbCd": "상품",
    "openApiNo": 1,
    "openApiNm": "상품등록API",
    "openApiUrl": "/api/intf/v1/goods/register/goods",
    "mjrVer": 1,
    "mnrVer": "00",
    "useYn": "Y",
    "sysRegId": "text",
    "sysRegDtm": "2026-01-01T00:00:00.000Z",
    "sysModId": "text",
    "sysModDtm": "2026-01-01T00:00:00.000Z"
  }
]

이전비밀번호 변경

다음게시글 정보 관리

마지막 업데이트 1일 전