기본 개발가이드

  • 카페24 쇼핑몰솔루션과 연계하여 동작할 수 있는 어플리케이션(App)을 개발하기 위한 기본 개발가이드 입니다.
  • App 개발을 위해 기본적으로 알아야 할 내용을 확인할 수 있습니다.

App 기본개념 및 용어

  • App은 애플리케이션(Application)의 약자로 제공되는 API를 이용하여 쇼핑몰 플랫폼과 함께 동작할 수 있도록 만들어진 다양한 프로그램을 의미합니다. 쇼핑몰 플랫폼과 연동할 수 있는 App의 제한은 없으며, 제공되는 서비스가 쇼핑몰 플랫폼과 잘 어우러져 서비스된다면 어떠한 서비스도 App으로의 제작 및 서비스가 가능합니다.
  •  
  • 이러한 창의적이고 다양한 App을 개발하기 위해서는 가이드의 확인과 커뮤니케이션에서 혼란이 발생하지 않도록 기본적인 용어를 아래와 같이 정의하여 사용하고 있습니다. 기본적인 용어를 숙지하여 사용한다면 명확한 커뮤니케이션을 통해 보다 쉽게 App의 개발이 가능할 것입니다.
기본 오류 코드 구조
용어 설명
APP 애플리케이션(Application)의 약자로 카페24 쇼핑몰 플랫폼의 API를 이용하여 제작되어 플랫폼과 함께 동작할 수 있도록 만들어진 프로그램을 의미합니다.
App은 Web과 Mobile(IOS, Android) 에서 구동하는 모든 서비스를 통칭하고 있습니다.
App은 App Store를 통해 쇼핑몰 운영자에게 판매할 수 있으며(이용료를 과금할 수 있으며), 서비스를 제공하는 개발사에서 독립적인 소스코드를 이용하여 구동됩니다.
API 애플리케이션 프로그래밍 인터페이스(Application Programming Interface)의 약자로 카페24 쇼핑몰 플랫폼과 애플리케이션, 서비스, 라이브러리 등과 표준화된 규약으로 상호간의 통신을 할 수 있는 인터페이스를 의미합니다.
RESTful 방식으로 제공되며 반드시 정해진 규약(인터페이스, 파라미터 등)을 통해 통신이 이루어집니다.
Admin API 와 Front API로 구분되어 있으며, Front API는 인증을 받지 않아도 호출이 가능한 API로 구성되어 있습니다.
클라이언트 아이디 일반적인 웹 서비스에서 아이디에 해당하는 값입니다. App이 쇼핑몰에 접근하여 데이터를 조회, 생성, 수정, 삭제 등을 하기 위해서 인증받은 사용자임을 증명하는 아이디에 해당합니다.
개발자센터에서 App 생성시 발급되는 App key 가 동일한 역할을 하고 있습니다.
클라이언트 시크릿 일반적인 웹 서비스에서 비밀번호에 해당하는 값입니다. App이 쇼핑몰에 접근하여 데이터를 조회, 생성, 수정, 삭제 등을 하기 위해서 인증받은 사용자임을 증명하는 비밀번호에 해당합니다.
개발자센터에서는 App 생성시 발급되는 App secret key 가 동일한 역할을 하고 있습니다.
App secret key는 비밀번호와 같이 보안상 중요한 값으로 분류되며, 비밀번호 재발급과 같이 재발급이 가능하며 재발급시 이전 secret key는 사용할 수 없습니다.
APP URL App이 서비스되기 위해 최초로 접근하는 URL 입니다. 일반적으로 App의 소개나 과금정보, 구매를 결정하는데 중요한 요인이 되는 정보를 포함하고 있거나 실제 서비스가 실행되는 개발사 런타임(Runtime) 서버의 URL을 의미합니다.
Redirect URL(s) App이 API에 요청(request)를 보낸 후 결과값(response)을 받는 URL의 리스트입니다.
복수개로 API 호출결과는 전송이 가능하나, 반드시 SSL (https) 프로토콜로 통신이 되어야 합니다.
요청 파라미터 API를 호출(request) 할 때 요청하는 정보를 서버로 전송하는 값(parameter) 입니다. API별로 사용하는 파라미터는 모두 다르게 제공됩니다. 자세한 파라미터는 API 개발가이드를 참고하시면 확인이 가능합니다.
HTTP Method Web을 이용한 API 통신을 할 때 요청과 응답데이터에 대한 역할을 정의하는 프로토콜 입니다.
카페24 API는 기본적으로 GET, POST, PUT, DEL 방식을 제공하여 API 통신을 하고 있습니다.
API를 호출하기 위해서는 4가지 방식의 메서드(Method) 중 하나를 사용하고 있으나 서로 교차사용은 불허하고 있습니다. (예: POST 방식인데 PUT을 사용)
API가 제공하는 메서드는 API 개발가이드를 통해 확인할 수 있습니다.
HTTP Status HTTP 상태코드라고 불리우며, API를 호출(Request)하는 경우 호출에 대한 결과(Response)에 대한 값을 상태코드와 함께 반환합니다. 상태코드는 IANA에서 정의한 HTTP Response Code를 기준으로 확장한 값을 제공하고 있습니다.
카페24 API에서 제공되는 자세한 상태코드를 확인하고 싶으신 경우 상태코드 및 오류메시지를 참고하시면 확인이 가능합니다.
OAuth 2.0 2008년 11월 IETF에서 정식으로 발족되어 발전하였으며 RFC 6749 문서로 표준화한 보안/인증방식입니다.
웹 서비스에 일반적인 로그인(아이디, 비밀번호를 이용한 로그인) 방식과 유사하게 아이디에 해당하는 Client ID(App Key)와 비밀번호에 해당하는 Client secret (App secret key)를 이용하여 인증(request_token)을 한 후 권한(access_token)을 확인하는 방식으로 인증됩니다.
일반적으로 구글, 페이스북 등의 서비스에 널리 이용되고 있는 체계적인 보안방식으로 카페24의 서비스는 OAuth2.0을 준수한 서비스를 제공하고 있습니다.
보다 자세한 내용은 보안/인증 개발가이드를 참고하시면 확인이 가능합니다.
Access_Token 플랫폼에 로그인할 때 만들어지며 사용자, 사용자그룹 정보 등 사용자를 식별하는데 필요한 정보를 담고있는 토큰(token) 입니다. 실제로 API를 호출하는데 필요한 사용자 인증 토큰입니다.
Refresh_Token Access_token의 사용주기는 비교적 짧은 편입니다. (일반적으로 1시간 유효) Access_Token이 만료되면 보안을 위해 새로운 토큰을 발급받아야 지속적인 사용이 가능한데 이때 Refresh_Token을 사용하여 재로그인 없이 Access_token의 갱신이 가능합니다.
보다 자세한 내용은 보안/인증 개발가이드를 참고하시면 확인이 가능합니다.
RESTful RESTful은 공식적으로 발표한 방식은 아니나 여러 개발자들이 오랜기간 비공식적으로 의견을 제시한 것으로 REST를 목적과 방향에 맞게 잘 사용하기 위해 정의된 방식입니다. 기본적으로 자원(Resource)의 대표(Representation)에 의한 상태전달을 의미한다고 볼 수 있습니다.
카페24 API는 RESTful을 기반으로 CRUD(생성, 조회, 수정, 삭제)의 기능을 명확하게 정의하여 제공하고 있습니다. 자세한 정의는 API 개발가이드를 참고하시면 확인이 가능합니다.
URI 인터넷에 있는 자원을 나타내는 유일한 주소를 의미합니다. URI의 존재는 인터넷에서 요구되는 기본조건으로서 인터넷 프로토콜에 항상 붙어 다닙니다. 기본적으로 흔히 알고 있는 URL은 URI의 한 종류입니다.
카페24의 URI는 SSL(https 프로토콜) 방식으로의 통신구간만 제공하고 있습니다.

App 기본 구조

  • 카페24 쇼핑몰 플랫폼에서 구입 및 사용할 수 있는 App을 개발하기 위해서는 기본적으로 아래와 같은 구조를 갖도록 권장하고 있습니다. 아래의 기본구조를 참고한다면 보다 원활한 App 개발이 가능할 것입니다.

App 기본 동작 프로세스

  • App 기본 동작 프로세스는 쇼핑몰에서 App Store를 통해 App을 구입하는 시점부터 App을 이용하기까지 App과 쇼핑몰 플랫폼간 처리되는 기본 프로세스를 안내합니다.

인증/보안 처리

  • 개발사에서는 개발자센터를 통해 발급받은 API key, API secret key를 이용하여 API 호출에 대한 권한과 사용을 인증 및 동의받아야 정상적인 API의 호출과 사용이 가능합니다.
  • 카페24의 인증/보안 시스템은 표준화된 OAuth 2.0을 기준으로 강력하고 체계적인 보안시스템을 제공합니다.
  • 보안시스템에 대한 적용에 있어서 예외적인 방법은 제공하지 않습니다.
  • 인증과 보안에 대한 정책 및 개발은 인증/보안 개발가이드를 참고할 수 있습니다.

카페24 API 사용

  • 카페24 쇼핑몰 플랫폼과 연동할 수 있는 다양한 종류의 API를 제공하고 있습니다. API는 기본적으로 RESTful 방식으로 서비스되어 API에 대한 기본 개발 지식만 있으면 누구나 쉽게 사용할 수 있습니다.
  • API는 쇼핑몰 플랫폼에 대한 기능개선에 맞추어 지속적으로 업데이트 되고 있습니다.
  • 자세한 API의 종류 및 사양, 활용법은 API 기본가이드를 참고할 수 있습니다.

쇼핑몰 운영자별 권한처리

  • 카페24 쇼핑몰 플랫폼은 대표운영자, 부운영자, 공급사운영자를 구분하여 관리할 수 있습니다. 이에 따라 App에서도 운영자별 권한을 구분하여 관리할 필요가 있을 수 있습니다.
  • App에서 쇼핑몰 운영자별 권한을 설정할 필요가 있거나 쇼핑몰에서 설정하는 운영자별 권한을 확인하고 싶은 경우 운영자 권한 개발가이드를 참고할 수 있습니다.

스크립트(Script) 처리 규칙

  • 카페24 개발자센터에서는 여러 개발사에서 제작하는 App간의 스크립트 충돌을 방지하기 위하여 스크립트 네임스페이스 처리를 권장하고 있습니다.
  • 네임스페이스 처리를 하지 않을 경우 App간의 스크립트 충돌로 인한 오류가 발생할 수 있습니다.
  • 스크립트의 네이밍(naming), 네임스페이스(name space)의 사용법 및 가이드는 Javascript 개발가이드를 참고바랍니다.

App Script 자동 반영 처리

  • App을 제작한 후 카페24 쇼핑몰에 App 설치시 App에서 사용하는 스크립트(Script)가 있을 경우 App에서 원하는 쇼핑몰 화면에 스크립트(Script)를 API를 이용하여 자동으로 적용할 수 있습니다.
  • 자세한 스크립트의 적용 방법 및 화면코드에 대한 개발가이드는 쇼핑몰 화면구조 및 API활용가이드를 참고할 수 있습니다.