For the complete documentation index, see llms.txt. This page is also available as Markdown.

랭킹 관리

랭킹 정보 등록 및 수정 및 삭제

post

기능설명

  • 랭킹 정보를 등록 및 수정 및 삭제하는 API 입니다.


상세설명

  • 입력 파라미터( * : 필수)

    • create : idxCd *, useYn *, attCd *, aplyWght *

    • update : rankModlSeq *,idxCd *, useYn *, attCd *, aplyWght *

    • delete : rankModlSeq *


Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

성공

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post/v1/search/rankMgmt/saveRankTypeList
POST /api/bo/v1/search/rankMgmt/saveRankTypeList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1062

{
  "all": [
    {
      "siteNo": 1,
      "rankModlSeq": 43,
      "rankPolcNm": "상품정책명",
      "idxCd": "goods",
      "idxCdNm": "상품",
      "attCd": 100,
      "attCdNm": "상품명",
      "attType": "text",
      "aplyCond1": 10,
      "aplyCond2": 20,
      "useYn": "Y",
      "aplyWght": 1000,
      "aplyStrDt": "2023-01-01",
      "aplyEndDt": "2023-12-31"
    }
  ],
  "create": [
    {
      "siteNo": 1,
      "rankModlSeq": 43,
      "rankPolcNm": "상품정책명",
      "idxCd": "goods",
      "idxCdNm": "상품",
      "attCd": 100,
      "attCdNm": "상품명",
      "attType": "text",
      "aplyCond1": 10,
      "aplyCond2": 20,
      "useYn": "Y",
      "aplyWght": 1000,
      "aplyStrDt": "2023-01-01",
      "aplyEndDt": "2023-12-31"
    }
  ],
  "update": [
    {
      "siteNo": 1,
      "rankModlSeq": 43,
      "rankPolcNm": "상품정책명",
      "idxCd": "goods",
      "idxCdNm": "상품",
      "attCd": 100,
      "attCdNm": "상품명",
      "attType": "text",
      "aplyCond1": 10,
      "aplyCond2": 20,
      "useYn": "Y",
      "aplyWght": 1000,
      "aplyStrDt": "2023-01-01",
      "aplyEndDt": "2023-12-31"
    }
  ],
  "delete": [
    {
      "siteNo": 1,
      "rankModlSeq": 43,
      "rankPolcNm": "상품정책명",
      "idxCd": "goods",
      "idxCdNm": "상품",
      "attCd": 100,
      "attCdNm": "상품명",
      "attType": "text",
      "aplyCond1": 10,
      "aplyCond2": 20,
      "useYn": "Y",
      "aplyWght": 1000,
      "aplyStrDt": "2023-01-01",
      "aplyEndDt": "2023-12-31"
    }
  ]
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

랭킹 목록 조회

get

기능설명

  • 랭킹 정보 목록을 조회하는 API 입니다.


상세설명

  • 검색조건 : 색인코드, 시작날짜, 종료날짜, 사용여부

  • 랭킹 목록은 랭킹모델순번 내림차순으로 노출됩니다.


수정번호

  • Release v1.04_231120 : 랭킹 설정

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
idxCdstringOptional

색인코드

Example: goods
startDateLocalDateOptional

시작날짜

Example: 20230101
endDateLocalDateOptional

종료날짜

Example: 20231231
useYnstringOptional

사용여부

Example: Y
pageIdxstringRequired

현재 페이지

Example: 1
rowsPerPagestringRequired

페이지 당 row

Example: 100
Responses
200

성공

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

get/v1/search/rankMgmt/getRankList
GET /api/bo/v1/search/rankMgmt/getRankList?pageIdx=text&rowsPerPage=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "totalCount": 1,
    "payloads": [
      {
        "siteNo": 1,
        "rankModlSeq": 43,
        "rankPolcNm": "상품정책명",
        "idxCd": "goods",
        "idxCdNm": "상품",
        "attCd": 100,
        "attCdNm": "상품명",
        "attType": "text",
        "aplyCond1": 10,
        "aplyCond2": 20,
        "useYn": "Y",
        "aplyWght": 1000,
        "aplyStrDt": "2023-01-01",
        "aplyEndDt": "2023-12-31"
      }
    ]
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

속성 중복 체크

get

기능설명

  • 동일 사이트에 동일 속성이 이미 등록되어 있는지 확인하는 API 입니다.


상세설명

  • siteNo와 attCd를 파라미터로 받아 중복 여부를 확인합니다.

  • 중복된 경우 1 이상의 숫자를, 중복되지 않은 경우 0을 반환합니다.


Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
siteNostringRequired

사이트번호

Example: 1
attCdstringRequired

속성코드

Example: 101
Responses
200

성공

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadinteger · int32Optional

payload

errorbooleanOptional

is error

get/v1/search/rankMgmt/checkDuplicatedAttribute
GET /api/bo/v1/search/rankMgmt/checkDuplicatedAttribute?siteNo=text&attCd=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": 1,
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

마지막 업데이트