OGQ Developers

OGQ Developers API 란?

OGQ Developers API는 OGQ 크리에이터들이 업로드한 디지털 콘텐츠들을 개발자들 쉽고, 빠르게 이용할 수 있게 웹 또는 SDK로 제공하는 기술들입니다.

어플리케이션 사용법

OGQ Developers API를 사용하기 위해서는 회원 가입후 어플리케이션을 생성하셔야 합니다. 어플리케이션 생성후 제공된 API를 사용하셔야 APP을 개발할 수 있고, 테스트할 수 있습니다. 내 어플리케이션의 어플리케이션 메뉴를 이용하여 생성할 수 있으며, 어플리케이션 마다 API 인증에 사용되는 고유한 어플리케이션 키(Application Key)가 발급됩니다.

1. 우측상단 [로그인] 버튼을 클릭 후 로그인을 합니다.
2. 상단 메뉴 [어플리케이션] 메뉴를 클릭합니다.
3. [어플리케이션 추가] 버튼을 눌러서 ① 어플리케이션 이름 ② 어플리케이션 설명 ③ 대표이미지 (선택) 를 입력 후 추가하기를 클릭합니다.
4. 발급된 테스트 어플리케이션 키(Application Key)를 가지고 API 개발 및 테스트를 진행합니다.
(테스트용 어플리케이션 키(Application Key)는 API호출수가 1,000건/일로 제한됩니다.)

개발 및 테스트 후 내 어플리케이션 > 어플리케이션 > [어플리케이션 상세] > 설정 메뉴에서 계좌등록 후 상용 서비스로 전환이 가능합니다.

API 인증

API 사용를 위한 Application Key는 어플리케이션을 인증하는 키 값으로 API 매 요청시 마다 아래와 같이 HTTP 헤더를 통해 보내주셔야 합니다.

X-OAPI-KEY

{Application Key}

Application Key는 외부에 노출된 경우를 대비하여, 최대 2개까지 생성할 수 있습니다. 보안을 위하여 Application Key를 주기적으로 변경하여 사용하실 것을 권장 드립니다.

[example]

curl -X

GET

'https://oapi.ogq.me/v1/stickers'

API 사용시 필수 요청 파라미터

OGQ Developers API 요청시 필수 파라미터로 userId를 함께 보내주셔야 합니다.
userId는 즐겨찾기 / 최근 사용 기능등 개인화 기능을 위해 사용됩니다.
또한 이는 고유한 사용자를 식별하여, MUU 값을 측정하는데 사용됩니다.

요청타입	파라미터 명	설명
Query Param	userId	어플리케이션 서비스 내에서 사용자를 식별할 수 있는 값

API 메시지 요청 및 응답 규격

요청타입

모든 API는 기본적으로 JSON 규격으로 구성됩니다.
요청시에는 필요에 따라 HTTP 파라미터를 사용합니다.
메시지 요청 타입은 아래와 같습니다.

요청타입	설명
header	HTTP 헤더로 전송되는 파라미터
Query Param	HTTP Request URL의 Query String으로 전송되는 파라미터
body	HTTP Body에 포함되는 파라미터 PUT/POST에 사용되며, JSON Object로 구성됨

응답 메시지 규격

OGQ Developers는 HTTP 상태 코드를 사용하여 API 호출 결과를 반환합니다.
응답에 사용되는 JSON 규격은 아래와 같습니다.

Http Body (Json Object)

code
상세 응답 코드 (성공시: 2XXXX)

data
성공시 API 별로 정해진 응답 결과 값이 포함 됨

message
실패시 에러에 대한 text 설명이 포함 됨

기술지원

ogq-developers@ogqcorp.com

API 관련 문의시에 OGQ Developers 사이트의 계정 정보와 API의 응답으로 받은 HTTP 헤더의 X-OAPI-RES-ID 등 상세 정보를 보내 주시면 보다 빠른 응대가 가능합니다.

Korea, South