OGQ Developers

이미지 검색

GET

/v1/images

요청타입	Parameter	Description	Required
Query Param	userId	서비스 내에서 사용자를 식별할수 있는 고유한 값	0
Query Param	pageSize	한번 요청으로 받을 이미지 콘텐츠의 수 입니다. 최대 100을 설정할 수 있으며, 기본값은 40입니다.	X
Query Param	page	페이지 번호 페이지 번호는 0번부터 시작합니다.	X
Query Param	keyword	이미지 검색에 사용할 키워드 키워드 값이 없을 경우 인기있는 이미지 리스트를 응답으로 반환합니다.	X
Query Param	creatorNames	검색 결과 중 크리에이터의 이름으로 검색 결과내 검색을 수행하게 됩니다. 크리에이터 명은 List로 전달 받습니다.	X

GET

`https://oapi.ogq.me/v1/images`

요청이 성공하면 응답 바디에 JSON 객체로 아래 값을 포함합니다.

파라미터명	타입	설명
hasNext	boolean	조회할 콘텐츠가 더 있는지 확인하는 필드, 만약 해당 조건으로 더 많은 데이터가 있다면, hasNext는 true 값을 반환합니다.
elements	object	검색된 이미지의 Content 리스트

elements

파라미터명	타입	설명
contentId	String	이미지 콘텐츠의 고유한 ID 값
title	String	이미지 콘텐츠의 이름
description	String	이미지 콘텐츠의 상세 설명
creator	object	해당 이미지 콘텐츠를 제작한 크리에이터의 정보를 표시합니다.
images	object	해당 이미지 콘텐츠에 포함된 상세 이미지 목록
feedbacks	object	개별 이미지에 대한 이벤트 정보 전달용 객체

creator

파라미터명	타입	설명
name	String	크리에이터의 이름
profileUrl	String	크리에이터의 프로필 이미지 URL

images

파라미터명	타입	설명
thumbnail	object	리스트 화면에서 보여줄 썸네일 이미지
web	object	스트리밍 또는 웹/앱에서 사용될 이미지

thumbnail

파라미터명	타입	설명
url	String	썸네일 이미지 URL
width	number	썸네일 이미지의 폭
height	number	썸네일 이미지의 높이

web

파라미터명	타입	설명
url	String	스트리밍 또는 웹/앱 이미지 URL
width	number	스트리밍 또는 웹/앱 이미지의 폭
height	number	스트리밍 또는 웹/앱 이미지의 높이

feedbacks

파라미터명	타입	설명
onUsed	String	개별 이미지가 사용되었을때, 호출할 URL

{
	"code": 20000,
	"data": {
		"hasNext": true,
		"elements": [
			{
				"contentId": "122283f2cff2",
				"title": "이미지의 제목",
				"description": "이미지의 설명",
				"creator": {
					"name": "testCreator",
					"profileUrl": "https://preview.files.api.ogq.me/profile/test/with/some_iamge.jpg?format=r240_240"
				},
				"images": {
					"thumbnail": {
						"url": "https://preview.files.api.ogq.me/thumbail/test/with/some_image.png?format=c240_240",
						"width": 240,
						"height": 135
					},
					"web": {
						"url": "https://preview.files.api.ogq.me/web/test/with/some_image.png?format=c240_240",
						"width": 720,
						"height": 405
					}
				},
				"feedbacks": {
					"onUsed": "https://oapi.ogq.me/v1/feedbacks?feedback_query_params"
				}
			}
		]
	}
}

이미지 즐겨찾기 목록 조회

GET

/v1/favorite-images

요청타입	Parameter	Description	Required
Query Param	userId	서비스 내에서 사용자를 식별할수 있는 고유한 값	0
Query Param	pageSize	한번 요청으로 받을 이미지 콘텐츠의 수 입니다. 최대 100을 설정할 수 있으며, 기본값은 40입니다.	X
Query Param	page	페이지 번호 페이지 번호는 0번부터 시작합니다.	X

GET

`https://oapi.ogq.me/v1/favorite-images`

요청이 성공하면 응답 바디에 JSON 객체로 아래 값을 포함합니다.

파라미터명	타입	설명
hasNext	boolean	조회할 콘텐츠가 더 있는지 확인하는 필드, 만약 해당 조건으로 더 많은 데이터가 있다면, hasNext는 true 값을 반환합니다.
elements	object	즐겨 찾기에 추가한 이미지 리스트

elements

파라미터명	타입	설명
contentId	String	이미지 콘텐츠의 고유한 ID 값
title	String	이미지 콘텐츠의 이름
description	String	이미지 콘텐츠의 상세 설명
creator	object	해당 이미지 콘텐츠를 제작한 크리에이터의 정보를 표시합니다.
images	object	해당 이미지 콘텐츠에 포함된 상세 이미지 목록
feedbacks	object	개별 이미지에 대한 이벤트 정보 전달용 객체

creator

파라미터명	타입	설명
name	String	크리에이터의 이름
profileUrl	String	크리에이터의 프로필 이미지 URL

images

파라미터명	타입	설명
thumbnail	object	리스트 화면에서 보여줄 썸네일 이미지
web	object	스트리밍 또는 웹/앱에서 사용될 이미지

thumbnail

파라미터명	타입	설명
url	String	썸네일 이미지 URL
width	number	썸네일 이미지의 폭
height	number	썸네일 이미지의 높이

web

파라미터명	타입	설명
url	String	스트리밍 또는 웹/앱 이미지 URL
width	number	스트리밍 또는 웹/앱 이미지의 폭
height	number	스트리밍 또는 웹/앱 이미지의 높이

feedbacks

파라미터명	타입	설명
onUsed	String	개별 이미지가 사용되었을때, 호출할 URL

{
	"code": 20000,
	"data": {
		"hasNext": true,
		"elements": [
			{
				"ordering": 1,
				"image": {
					"contentId": "122283f2cff2",
					"title": "이미지의 제목",
					"description": "이미지의 설명",
					"creator": {
						"name": "testCreator",
						"profileUrl": "https://preview.files.api.ogq.me/profile/test/with/some_iamge.jpg?format=r240_240"
					},
					"images": {
						"thumbnail": {
							"url": "https://preview.files.api.ogq.me/thumbail/test/with/some_image.png?format=c240_240",
							"width": 240,
							"height": 135
						},
						"web": {
							"url": "https://preview.files.api.ogq.me/web/test/with/some_image.png?format=c240_240",
							"width": 720,
							"height": 405
						}
					},
					"feedbacks": {
						"onUsed": "https://oapi.ogq.me/v1/feedbacks?feedback_query_params"
					}
				}
			}
		]
	}
}

이미지 즐겨찾기 목록 추가

POST

/v1/favorite-images

요청타입	Parameter	Description	Required
Query Param	userId	서비스 내에서 사용자를 식별할수 있는 고유한 값	0
Body	contentIds	즐겨 찾기에 추가할 이미지 ID 리스트	0

POST

`https://oapi.ogq.me/v1/favorite-images`

{
	"contentIds": [
		"17506d5fe220111",
		"17506d5fe220112",
		"17506d5fe220113"
	]
}

즐겨찾는 이미지 순서변경

PUT

/v1/favorite-images?userId={userId}

요청타입	Parameter	Description	Required
Query Param	userId	서비스 내에서 사용자를 식별할수 있는 고유한 값	0
Body	favoriteItems	즐겨찾는 항목 아이템 리스트	0

favoriteItems

요청타입	Parameter	Description	Required
Body	contentId	즐겨 찾기에 추가한 이미지 ID	X
Body	ordering	즐겨 찾기 이미지의 순서	X

PUT

`https://oapi.ogq.me/v1/favorite-images?userId={userId}`

{
	"favoriteItems": [
		{
			"contentId": "17506d5fe220111",
			"ordering": 3
		},
		{
			"contentId": "17506d5fe220112",
			"ordering": 4
		}
	]
}

이미지 즐겨찾는 삭제

DELETE

/v1/favorite-images/{contentId}

요청타입	Parameter	Description	Required
Query Param	userId	서비스 내에서 사용자를 식별할수 있는 고유한 값	0
path	contentId	이미지 즐겨찾기에서 삭제 할 contentId	0

DELETE

`https://oapi.ogq.me/v1/favorite-images/{contentId}`

최근 사용한 이미지 목록 조회

GET

/v1/recent-images

요청타입	Parameter	Description	Required
Query Param	userId	서비스 내에서 사용자를 식별할수 있는 고유한 값	0
Query Param	pageSize	한번 요청으로 받을 이미지 콘텐츠의 수 입니다. 최대 100을 설정할 수 있으며, 기본값은 40입니다.	X
Query Param	page	페이지 번호 페이지 번호는 0번부터 시작합니다.	X

GET

`https://oapi.ogq.me/v1/recent-images`

요청이 성공하면 응답 바디에 JSON 객체로 아래 값을 포함합니다.

파라미터명	타입	설명
elements	object	최근 사용 이미지 리스트

elements

파라미터명	타입	설명
recentId	String	최근 사용 ID
image	list	최근에 사용한 이미지 콘텐츠

image

파라미터명	타입	설명
contentId	String	이미지 콘텐츠의 고유한 ID 값
title	String	이미지 콘텐츠의 이름
description	String	이미지 콘텐츠의 상세 설명
creator	object	해당 이미지 콘텐츠를 제작한 크리에이터의 정보를 표시합니다.
images	object	해당 이미지 콘텐츠에 포함된 상세 이미지 목록
feedbacks	object	개별 이미지에 대한 이벤트 정보 전달용 객체

creator

파라미터명	타입	설명
name	String	크리에이터의 이름
profileUrl	String	크리에이터의 프로필 이미지 URL

images

파라미터명	타입	설명
thumbnail	object	리스트 화면에서 보여줄 썸네일 이미지
web	number	스트리밍 또는 웹/앱에서 사용될 이미지

feedbacks

파라미터명	타입	설명
onUsed	String	개별 이미지가 사용되었을때, 호출할 URL

{
	"code": 20000,
	"data": {
		"elements": [
			{
				"recentId": 0,
				"usedItemId": "1",
				"image": {
					"contentId": "122283f2cff2",
					"title": "이미지의 제목",
					"description": "이미지의 설명",
					"creator": {
						"name": "testCreator",
						"profileUrl": "https://preview.files.api.ogq.me/profile/test/with/some_iamge.jpg?format=r240_240"
					},
					"images": {
						"thumbnail": {
							"url": "https://preview.files.api.ogq.me/thumbail/test/with/some_image.png?format=c240_240",
							"width": 240,
							"height": 135
						},
						"web": {
							"url": "https://preview.files.api.ogq.me/web/test/with/some_image.png?format=c240_240",
							"width": 720,
							"height": 405
						}
					},
					"feedbacks": {
						"onUsed": "https://oapi.ogq.me/v1/feedbacks?feedback_query_params"
					}
				}
			}
		]
	}
}

최근 사용한 이미지 삭제

DELETE

/v1/recent-images/{recentId}

요청타입	Parameter	Description	Required
Query Param	userId	서비스 내에서 사용자를 식별할수 있는 고유한 값	0
path	recentId	최근 사용 이미지에서 삭제 할 Id	0

DELETE

`https://oapi.ogq.me/v1/recent-images/{recentId}`

이미지 스트리밍

GET

/v1/images/{contentId}/streamingUrl

요청타입	Parameter	Description	Required
Query Param	userId	서비스 내에서 사용자를 식별할수 있는 고유한 값	0
Query Param	policyCode	스트리밍 라이선스 타입 (예: OGQ-IMAGE-SR)	X
Path	contentId	스트리밍 제공할 이미지 콘텐츠 ID.	0

GET

`https://oapi.ogq.me/v1/images/{contentId}/streamingUrl`

요청이 성공하면 응답 바디에 JSON 객체로 아래 값을 포함합니다.

파라미터명	타입	설명
imageUrl	String	워터마크가 제가된 이미지 URL. 이 URL은 24시간 동안 유효합니다. (※주의. 24시간 이후 사용 할 수 없는 url이므로 상용 서비스시 저장 후 이용 하시길 바랍니다.)

{
	"code": 20000,
	"data": {
		"imageUrl": "https://preview.files.api.ogq.me/STOCK_IMAGE_BULK/3fb800f3/5a51e3f008bf3/OGQ_jrjeon_2020-05-08.jpg?format=w1280_cc"
	}
}

피드백 API

GET

/v1/feedbacks

GET

`https://oapi.ogq.me/v1/feedbacks`

Korea, South