Data Management API 가이드

개요

Data Management API를 통해 고객사 상 DB를 관리합니다.

Management API는 실시간으로 고객사의 상품 DB에 반영을 하여 해당 상품 DB를 기준으로 Recommendation API의 검색 Index를 생성하게 됩니다. 단, Recommendation API의 검색 Index 현행화는 Management API의 요청을 받아 상품 DB 반영이후, 익일에 이루어 집니다.

• GET / : 현재 DB 정보 확인

• POST /?action=update : Data Update

• POST /?action=delete : Data Delete

Endpoint

현재 지원되고 있는 Lens API Version은 두가지가 있습니다

Version 1.1:

https://api.omnious.com/lens/v1.1/dbapi.omnious.com

Version 1.2:

https://api.omnious.com/lens/v1.2/dbapi.omnious.com

Version 1.3: 신규로 Lens를 사용하시는 경우 해당 Version 사용하시는 것을 추천드립니다

https://api.omnious.com/lens/v1.3/dbapi.omnious.com

GET /

현재 DB 정보를 확인합니다.

요청

Header

Name	Description
Content-Type	application/json
x-api-key	{omnious 로 부터 발급 받은 API Key} [Required]

응답

Response Data

Name	Type	Description
name	String	검색 DB의 이름
updateDate	Datetime	검색 DB의 항목이 변경된 시점
indexDate	Datetime	검색 DB의 항목이 Index에 반영된 시점
totalCount	Int	검색 DB내의 전체 상품 수

Example. DB 정보 조회 (HTTP Status Code: 200)

{
  "status": "ok",
  "error": null,
  "data": {
    "name": "ABCD 몰 상품 추천 DB",
    "updateDate": "2020-01-08 20:00:23",
    "indexDate": "2020-01-08 23:39:17",
    "totalCount": 655000
  }
}

POST /?action=update

새로운 Data를 등록하거나 기존 Data를 Update 합니다. 만약 기존에 등록된 상품코드가 존재한다면, 새로 등록되는 정보로 Update 됩니다.

한 Request 당 최대 1,000개 까지 한 번에 update 가능합니다.

요청

Header

Name	Description
Content-Type	application/json
x-api-key	{omnious 로 부터 발급 받은 API Key} [Required]

Body

JSON Object Array 형태로 아래와 같이 추천에 노출할 상품의 정보를 입력합니다.

Name	Type	Description
product	Array of Objects	입력 또는 수정할 상품 정보의 List

상품 정보 Object

Name	Type	Description
id	String	(중요) 상품 코드로써 해당 DB 내에서 Unique Key로 사용됩니다.
url	String	상품 페이지 URL
image.detection	String	Detection 정보의 값 중 하나를 선택합니다. (예: TOP)
image.content	String	상품 대표 이미지 URL
context.name	String	상품명
context.gender	String	성별 (예: MAN, WOMAN, UNISEX)
context.brand	String	브랜드
context.price.currency	String	상품 가격의 통화 단위 (예: KRW)
context.price.value	Float	상품의 가격
context.price.discounted	Float	(할인한 경우) 할인된 가격
context.mobilePrice.currency	String	상품 가격의 통화 단위 (예: KRW)
context.mobilePrice.value	Float	상품의 가격
context.mobilePrice.discounted	Float	(할인한 경우) 할인된 가격
metadata.{미리 정의된 필드 이름}	Int or String	메타데이터 필터는 v1.3에서 사용하실 수 있습니다.

Detection 정보

다음 값 중 하나를 선택하여 이미지 상에서 추천에 사용될 항목을 특정합니다.

Field	Description
SHOES	신발
BAG	가방
HAT	모자
GLASSES	안경, 선글라스류
BELT	벨트
WATCH	손목시계
TOP	상의 (블라우스, 셔츠, 니트웨어 등)
OUTWEAR	코트, 자켓, 점퍼, 패딩 등
SKIRT	스커트
PANTS	바지류
WHOLEBODY	드레스, 점프슈트 등
JEWELRY	쥬얼리 (반지, 목걸이 등)
ACCESSORY	헤어 악세서리

Example. 상품 1개 등록

{
  "products": [
    {
      "id": "AT000123FB",
      "url": "http://asdfmall/product?id=AT00123FB",
      "image": {
        "detection": "TOP",
        "content": "http://some/image.jpg"
      },
      "context": {
        "name": "집업 후드",
        "gender": "MAN",
        "brand": "GAP",
        "price": {
          "currency": "KRW",
          "value": 12000,
          "discounted": 9900
        }
        "mobilePrice": {
          "currency": "KRW",
          "value": 11000,
          "discounted": 9900
        }
      }
    }
  ]
}

Example. 2개 이상의 상품을 한 번에 등록

{
  "products": [
    {
      "id": "AT000123FB",
      "url": "http://asdfmall/product?id=AT00123FB",
      "image": {
        "detection": "TOP",
        "content": "http://some/image.jpg"
      },
      "context": {
        "name": "집업 후드",
        "gender": "MAN",
        "brand": "GAP",
        "price": {
          "currency": "KRW",
          "value": 12000,
          "discounted": 9900
        }
        "mobilePrice": {
          "currency": "KRW",
          "value": 11000,
          "discounted": 9900
        }
      }
    },
    {
      "id": "AT280143GQ",
      "url": "http://asdfmall/product?id=AT280143GQ",
      "image": {
        "detection": "SHOES",
        "content": "http://some/image.jpg"
      },
      "context": {
        "name": "에어맥스 운동화",
        "gender": "MAN",
        "brand": "NIKE",
        "price": {
          "currency": "KRW",
          "value": 120000,
          "discounted": 99000
        }
        "mobilePrice": {
          "currency": "KRW",
          "value": 11000,
          "discounted": 9900
        }
      }
    }
  ]
}

Example. (metadata filter) 상품별 Metadata 등록

{
  "products": [
    {
      "id": "AT000123FB",
      "url": "http://asdfmall/product?id=AT00123FB",
      "image": {
        "detection": "TOP",
        "content": "http://some/image.jpg"
      },
      "context": {
        "name": "집업 후드",
        "gender": "MAN",
        "brand": "GAP",
        "price": {
          "currency": "KRW",
          "value": 12000,
          "discounted": 9900
        },
        "mobilePrice": {
          "currency": "KRW",
          "value": 11000,
          "discounted": 9900
        }
      },
      "metadata": {
        "color": "white",
        "date": "2022-02-24T00:00:00",
        "event": "progress"
      }
    },
    {
      "id": "AT280143GQ",
      "url": "http://asdfmall/product?id=AT280143GQ",
      "image": {
        "detection": "SHOES",
        "content": "http://some/image.jpg"
      },
      "context": {
        "name": "에어맥스 운동화",
        "gender": "MAN",
        "brand": "NIKE",
        "price": {
          "currency": "KRW",
          "value": 120000,
          "discounted": 99000
        },
        "mobilePrice": {
          "currency": "KRW",
          "value": 11000,
          "discounted": 9900
        }
      },
      "metadata": {
        "color": "black",
        "date": "2022-02-24T00:00:00",
        "event": "progress"
      }
    }
  ]
}

응답

Example. 등록 요청 수락 (HTTP Status Code: 200)

{
  "status": "ok",
  "error": null,
  "data": {
    "update": 2
  }
}

POST /?action=delete

상픔 코드를 기준으로 DB에 등록된 상품을 삭제합니다.

한 Request 당 최대 1,000개 까지 한 번에 delete 가능합니다.

요청

Header

Name	Description
Content-Type	application/json
x-api-key	{omnious 로 부터 발급 받은 API Key} [Required]

Body

JSON Object Array 형태로 아래와 같이 삭제할 상품의 코드를 입력합니다.

Example. 2개의 상품정보 삭제 요청

{
  "ids": [
    "AT000123FB",
    "AT059253WA"
  ]
}

응답

Example. 삭제 요청 수락 (HTTP Status Code: 200)

삭제 요청된 상품의 수량을 리턴합니다.

{
  "status": "ok",
  "error": null,
  "data": {
    "delete": 2
  }
}