Tagging API
API Endpoint
기본 API Endpoint는 아래와 같으며, 현재 최신 버전은 2024-02 입니다.
Tagging API
GET /tagging/tags/<product id>: 태깅 결과 전달
해당하는 상품 아이디에 대한 태깅 결과를 전달합니다.
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-Api-Key | 필수 | String | API Key (참조: API 인증 가이드) |
| Content-Type | 필수 | String | 요청 Type. Application/json 만 지원합니다. |
| Accept-Language | 필수 | String | 태깅 결과를 받을 언어를 선택합니다. KO, ko-KR (한국어) | EN, en-US(영어(미국)) | en-UK(영어(영국)) | ZH(중국어) | JA(일본어) 중 하나 선택. (default: en-US) |
Request Parameter
| Name | Required | Type | Description |
|---|---|---|---|
| options | 선택 | List[String] | 입력 옵션. 아래와 같이 미리 정의된 String Enum type으로 넣어줍니다: MATCHED_DETECTION: Management API 호출 시 입력한 Detection과 동일한 항목만 matchedObjects에 전달합니다. |
| includeCategoryGroups | 선택 | List[String] | 결과로 받을 카테고리 그룹 정보 [CLOTHING, SHOES, BAGS, ACCESSORIES, HATS, JEWELRIES] |
정보
options의 MATCHED_DETECTION을 입력 시 includeCategoryGroups는 무시됩니다.
Request Example
/tagging/tags/A1101?options=MATCHED_DETECTION&includeCategoryGroups=CLOTHING&includeCategoryGroups=SHOES&includeCategoryGroups=BAGS
Response
| Name | Type | Description |
|---|---|---|
| productInfo | Object | 상품 정보 |
| ├ productInfo.id | String | 상품 아이디 |
| ├ productInfo.url | String | 상품의 대표 이미지 URL |
| ├ productInfo.salesUrl | String | 상품이 판매되고 있는 페이지의 URL |
| ├ productInfo.mobileSalesUrl | String | 상품이 판매되고 있는 페이지의 모바일 버전 URL |
| ├ productInfo.detection | String | 상품에 대한 Detection 정보 (참조: Detection 정보) |
| └ productInfo.metadata | Object | 상품에 대한 메타정보 (참조: 상품 Meta 정보) |
| notMatchedObjects | List[TaggedObject] | Detection 정보와 매칭이 되지 않은 태깅 정보 |
| matchedObjects | List[TaggedObject] | 상품 정보(또는 includeCategoryGroups)와 매칭된 태깅 정보 |
TaggedObject
| Name | Type | Description |
|---|---|---|
| type | String | “CLOTHING”, “SHOES”, "BAGS", "HATS", "JEWELRIES", "ACCESSORIES", "no detected product" 중 하나로 정의 |
| tags | List[Object] | 상세 태깅 정보 (참조: Tagging Result Object) |
Response Example
400 Bad Request
{
"errors": "Invalid Request"
}
201 Created 태깅 결과가 있는 경우
{
"notMatchedObjects": [
{
"tags": [
{
"category": {
"confidence": 0.94590384,
"id": "T0372",
"name": "skirts"
},
"colors": [
{
"confidence": 0.9809965,
"id": "T0324",
"name": "black"
},
{
"confidence": 0.0081905,
"id": "T0333",
"name": "navy"
},
{
"confidence": 0.007581547,
"id": "T0327",
"name": "brown"
}
],
"details": [
{
"confidence": 0.63851166,
"id": "T0466",
"name": "unbalanced"
},
{
"confidence": 0.14863706,
"id": "T0115",
"name": "pockets"
},
{
"confidence": 0.115386054,
"id": "T0124",
"name": "slit"
}
],
"fit": null,
"item": {
"confidence": 0.94590384,
"id": "T0057",
"name": "skirt"
},
"length": {
"confidence": 0.9470655,
"id": "T0473",
"name": "mini"
},
"looks": [
{
"confidence": 0.5856359,
"id": "T0141",
"name": "casual"
}
],
"neckLine": null,
"position": {
"x": 0.36875,
"y": 0.46640627500000004
},
"prints": [
{
"confidence": 0.99943763,
"id": "T0198",
"name": "solid"
}
],
"shape": {
"confidence": 0.8846603,
"id": "T0488",
"name": "a-line"
},
"sleeveLength": null,
"textures": [
{
"confidence": 0.35057074,
"id": "T0219",
"name": "wool/cashmere"
}
]
}
],
"type": "CLOTHING"
}
],
"matchedObjects": [
{
"tags": [
{
"category": {
"confidence": 0.76246446,
"id": "T0367",
"name": "knitwear"
},
"colorDetails": [
],
"colors": [
{
"confidence": 0.92697847,
"id": "T0330",
"name": "grey"
},
{
"confidence": 0.030493207,
"id": "T0324",
"name": "black"
},
{
"confidence": 0.02344105,
"id": "T0339",
"name": "khaki"
}
],
"details": [
{
"confidence": 0.9165029,
"id": "T0102",
"name": "drop-shoulder"
},
{
"confidence": 0.025800427,
"id": "T0098",
"name": "cable"
},
{
"confidence": 0.02092917,
"id": "T0120",
"name": "roll-up"
}
],
"fit": {
"confidence": 0.9126808,
"id": "T0477",
"name": "normal"
},
"item": {
"confidence": 0.76246446,
"id": "T0014",
"name": "sweater"
},
"length": {
"confidence": 0.8747827,
"id": "T0474",
"name": "normal"
},
"looks": [
{
"confidence": 0.9710153,
"id": "T0141",
"name": "casual"
}
],
"neckLine": {
"confidence": 0.9983069,
"id": "T0293",
"name": "round-neck"
},
"position": {
"x": 0.454687485,
"y": 0.29501955
},
"prints": [
{
"confidence": 0.95590585,
"id": "T0179",
"name": "stripe"
}
],
"shape": null,
"sleeveLength": {
"confidence": 0.99952877,
"id": "T0082",
"name": "long-sleeve"
},
"textures": [
{
"confidence": 0.71867925,
"id": "T0207",
"name": "knit"
}
]
}
],
"type": "CLOTHING"
}
],
"productInfo": {
"detection": "TOP",
"id": "A1000",
"metadata": {
"brand": "다밍",
"currency": "KRW",
"discountPrice": 39000.0,
"gender": "WOMEN",
"mobileCurrency": "",
"mobilePrice": 0.0,
"name": "호웰니트",
"price": 39000.0
},
"mobileSalesUrl": null,
"salesUrl": "https://salesUrl.com/products/A1000",
"url": "https://image.url.com/image.jpg"
}
}
201 Created 태깅 결과가 있고 includeCategoryGroup=["CLOTHING"] 인 경우
{
"notMatchedObjects": [],
"matchedObjects": [
{
"tags": [
{
"category": {
"confidence": 0.76246446,
"id": "T0367",
"name": "knitwear"
},
"colorDetails": [
],
"colors": [
{
"confidence": 0.92697847,
"id": "T0330",
"name": "grey"
},
{
"confidence": 0.030493207,
"id": "T0324",
"name": "black"
},
{
"confidence": 0.02344105,
"id": "T0339",
"name": "khaki"
}
],
"details": [
{
"confidence": 0.9165029,
"id": "T0102",
"name": "drop-shoulder"
},
{
"confidence": 0.025800427,
"id": "T0098",
"name": "cable"
},
{
"confidence": 0.02092917,
"id": "T0120",
"name": "roll-up"
}
],
"fit": {
"confidence": 0.9126808,
"id": "T0477",
"name": "normal"
},
"item": {
"confidence": 0.76246446,
"id": "T0014",
"name": "sweater"
},
"length": {
"confidence": 0.8747827,
"id": "T0474",
"name": "normal"
},
"looks": [
{
"confidence": 0.9710153,
"id": "T0141",
"name": "casual"
}
],
"neckLine": {
"confidence": 0.9983069,
"id": "T0293",
"name": "round-neck"
},
"position": {
"x": 0.454687485,
"y": 0.29501955
},
"prints": [
{
"confidence": 0.95590585,
"id": "T0179",
"name": "stripe"
}
],
"shape": null,
"sleeveLength": {
"confidence": 0.99952877,
"id": "T0082",
"name": "long-sleeve"
},
"textures": [
{
"confidence": 0.71867925,
"id": "T0207",
"name": "knit"
}
]
},
{
"category": {
"confidence": 0.94590384,
"id": "T0372",
"name": "skirts"
},
"colors": [
{
"confidence": 0.9809965,
"id": "T0324",
"name": "black"
},
{
"confidence": 0.0081905,
"id": "T0333",
"name": "navy"
},
{
"confidence": 0.007581547,
"id": "T0327",
"name": "brown"
}
],
"details": [
{
"confidence": 0.63851166,
"id": "T0466",
"name": "unbalanced"
},
{
"confidence": 0.14863706,
"id": "T0115",
"name": "pockets"
},
{
"confidence": 0.115386054,
"id": "T0124",
"name": "slit"
}
],
"fit": null,
"item": {
"confidence": 0.94590384,
"id": "T0057",
"name": "skirt"
},
"length": {
"confidence": 0.9470655,
"id": "T0473",
"name": "mini"
},
"looks": [
{
"confidence": 0.5856359,
"id": "T0141",
"name": "casual"
}
],
"neckLine": null,
"position": {
"x": 0.36875,
"y": 0.46640627500000004
},
"prints": [
{
"confidence": 0.99943763,
"id": "T0198",
"name": "solid"
}
],
"shape": {
"confidence": 0.8846603,
"id": "T0488",
"name": "a-line"
},
"sleeveLength": null,
"textures": [
{
"confidence": 0.35057074,
"id": "T0219",
"name": "wool/cashmere"
}
]
}
],
"type": "CLOTHING"
}
],
"productInfo": {
"detection": "TOP",
"id": "A1000",
"metadata": {
"brand": "다밍",
"currency": "KRW",
"discountPrice": 39000.0,
"gender": "WOMEN",
"mobileCurrency": "",
"mobilePrice": 0.0,
"name": "호웰니트",
"price": 39000.0
},
"mobileSalesUrl": null,
"salesUrl": "https://salesUrl.com/products/A1000",
"url": "https://image.url.com/image.jpg"
}
}
200 OK 태깅 결과가 없는 경우
{
"notMatchedObjects": [],
"matchedObjects": [],
"productInfo": {
"detection": "JEWELRY",
"id": "A1000",
"metadata": {
"brand": "피아네",
"currency": "KRW",
"discountPrice": 10800.0,
"gender": "WOMEN",
"mobileCurrency": "",
"mobilePrice": 0.0,
"name": "-",
"price": 12000.0
},
"mobileSalesUrl": null,
"salesUrl": "https://salesUrl.com/products/A1000",
"url": "https://image.url.com/image.jpg"
}
}
POST /tagging/tags: 여러 상품의 태깅 결과 전달
여러 상품의 (최대 100개 까지) 태깅 결과를 한 번에 전달합니다. 요청으로 상품 Id의 List를 아래에 정의된 형식으로 받습니다.
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-Api-Key | 필수 | String | API Key (참조: API 인증 가이드) |
| Content-Type | 필수 | String | 요청 Type. Application/json 만 지원합니다. |
| Accept-Language | 필수 | String | 태깅 결과를 받을 언어를 선택합니다. KO, ko-KR (한국어) | EN, en-US(영어(미국)) | en-UK(영어(영국)) | ZH(중국어) | JA(일본어) 중 하나 선택. (default: en-US) |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| productIds | 필수 | List[String] | 상품 아이디의 List. 최대 100개 까지 가능합니다. |
| includeCategoryGroups | 선택 | List[String] | 결과로 받을 카테고리 그룹 정보 [CLOTHING, SHOES, BAGS, ACCESSORIES, HATS, JEWELRIES] |
| options | 선택 | List[String] | 입력 옵션. 아래와 같이 미리 정의된 String Enum type으로 넣어줍니다: MATCHED_DETECTION: Management API 호출 시 입력한 Detection과 동일한 항목만 matchedObjects에 전달합니다. |
Request Example
{
"productIds": [
"A1000", "A1001", "A1002"
],
"includeCategoryGroups": ["CLOTHING"],
"options": ["MATCHED_DETECTION"]
}
Response
| Name | Type | Description |
|---|---|---|
| complete | Object | 요청한 상품 중 분석이 완료된 상품에 대한 정보 |
| ├ complete.count | Integer | 요청한 상품 중 분석이 완료된 상품의 수량 |
| └ complete.products | List[Products] | 분석이 완료된 상품의 태깅 정보 (아래의 Products 참조) |
| failed | Object | 요청한 상품 중 분석에 실패한 상품에 대한 정보 |
| ├ failed.count | Integer | 요청한 상품 중 분석에 실패한 상품의 수량 |
| └ failed.errors | List[Object] | 분석에 실패한 상품의 상세 오류 정보 |
| ㅤ├ failed.errors[].id | String | 분석에 실패한 상품의 아이디 |
| ㅤ└ failed.errors[].errors | String | 분석에 실패한 상품의 오류에 대한 설명 |
Products
| Name | Type | Description |
|---|---|---|
| productInfo | Object | 상품 정보 |
| ├ productInfo.id | String | 상품 아이디 |
| ├ productInfo.url | String | 상품의 대표 이미지 URL |
| ├ productInfo.salesUrl | String | 상품이 판매되고 있는 페이지의 URL |
| ├ productInfo.mobileSalesUrl | String | 상품이 판매되고 있는 페이지의 모바일 버전 URL |
| ├ productInfo.detection | String | 상품에 대한 Detection 정보 (참조: Detection 정보) |
| └ productInfo.metadata | Object | 상품에 대한 메타정보 (참조: 상품 Meta 정보) |
| notMatchedObjects | List[TaggedObject] | Detection 정보와 매칭이 되지 않은 태깅 정보 |
| matchedObjects | List[TaggedObject] | 상품 정보(또는 includeCategoryGroups)와 매칭된 태깅 정보 |
TaggedObject
| Name | Type | Description |
|---|---|---|
| type | String | “CLOTHING”, “SHOES”, "BAGS", "HATS", "JEWELRIES", "ACCESSORIES", "no detected product" 중 하나로 정의 |
| tags | List[Object] | 상세 태깅 정보 (참조: Tagging Result Object) |
400 Bad Request
{
"errors": "json format error."
}
201 Created
{
"complete": {
"count": 1,
"products": [
...//GET /tagging/tags/<product id> 의 결과 값과 동일
]
},
"failed": {
"count": 1,
"errors": [
{
"id": "A1000",
"errors": "fail to prove image from url."
}
]
}
}
Full Example
{
"complete": {
"count": 1,
"products": [
{
"notMatchedObjects": [
{
"tags": [
{
"category": {
"confidence": 0.94590384,
"id": "T0372",
"name": "skirts"
},
"colors": [
{
"confidence": 0.9809965,
"id": "T0324",
"name": "black"
},
{
"confidence": 0.0081905,
"id": "T0333",
"name": "navy"
},
{
"confidence": 0.007581547,
"id": "T0327",
"name": "brown"
}
],
"details": [
{
"confidence": 0.63851166,
"id": "T0466",
"name": "unbalanced"
},
{
"confidence": 0.14863706,
"id": "T0115",
"name": "pockets"
},
{
"confidence": 0.115386054,
"id": "T0124",
"name": "slit"
}
],
"fit": null,
"item": {
"confidence": 0.94590384,
"id": "T0057",
"name": "skirt"
},
"length": {
"confidence": 0.9470655,
"id": "T0473",
"name": "mini"
},
"looks": [
{
"confidence": 0.5856359,
"id": "T0141",
"name": "casual"
}
],
"neckLine": null,
"position": {
"x": 0.36875,
"y": 0.46640627500000004
},
"prints": [
{
"confidence": 0.99943763,
"id": "T0198",
"name": "solid"
}
],
"shape": {
"confidence": 0.8846603,
"id": "T0488",
"name": "a-line"
},
"sleeveLength": null,
"textures": [
{
"confidence": 0.35057074,
"id": "T0219",
"name": "wool/cashmere"
}
]
}
],
"type": "CLOTHING"
}
],
"matchedObjects": [
{
"tags": [
{
"category": {
"confidence": 0.76246446,
"id": "T0367",
"name": "knitwear"
},
"colorDetails": [
],
"colors": [
{
"confidence": 0.92697847,
"id": "T0330",
"name": "grey"
},
{
"confidence": 0.030493207,
"id": "T0324",
"name": "black"
},
{
"confidence": 0.02344105,
"id": "T0339",
"name": "khaki"
}
],
"details": [
{
"confidence": 0.9165029,
"id": "T0102",
"name": "drop-shoulder"
},
{
"confidence": 0.025800427,
"id": "T0098",
"name": "cable"
},
{
"confidence": 0.02092917,
"id": "T0120",
"name": "roll-up"
}
],
"fit": {
"confidence": 0.9126808,
"id": "T0477",
"name": "normal"
},
"item": {
"confidence": 0.76246446,
"id": "T0014",
"name": "sweater"
},
"length": {
"confidence": 0.8747827,
"id": "T0474",
"name": "normal"
},
"looks": [
{
"confidence": 0.9710153,
"id": "T0141",
"name": "casual"
}
],
"neckLine": {
"confidence": 0.9983069,
"id": "T0293",
"name": "round-neck"
},
"position": {
"x": 0.454687485,
"y": 0.29501955
},
"prints": [
{
"confidence": 0.95590585,
"id": "T0179",
"name": "stripe"
}
],
"shape": null,
"sleeveLength": {
"confidence": 0.99952877,
"id": "T0082",
"name": "long-sleeve"
},
"textures": [
{
"confidence": 0.71867925,
"id": "T0207",
"name": "knit"
}
]
}
],
"type": "CLOTHING"
}
],
"productInfo": {
"detection": "TOP",
"id": "A1000",
"metadata": {
"brand": "다밍",
"currency": "KRW",
"discountPrice": 39000.0,
"gender": "WOMEN",
"mobileCurrency": "",
"mobilePrice": 0.0,
"name": "호웰니트",
"price": 39000.0
},
"mobileSalesUrl": null,
"salesUrl": "https://salesUrl.com/products/A1000",
"url": "https://image.url.com/image.jpg"
}
}
]
},
"failed": {
"count": 1,
"errors": [
{
"id": "A1000",
"errors": "fail to prove image from url."
}
]
}
}