API 안내

CJ온스타일 API 소개

  • CJ온스타일 API 서비스는 CJ온스타일에 입점한 협력사들이 파트너시스템 뿐만 아니라 다양한 방법으로 외부에서 사용할 수 있도록 제공하는 인터페이스입니다.
  • API를 사용하기 위해서는 우선 CJ온스타일과 계약을 진행해야 하며, API KEY 발급 및 IP 방화벽 허용 등을 진행한 뒤에 사용할 수 있습니다.
  • API는 총 5개의 구분이 존재하며, 각 구분별로 상세 API가 나뉘어져 있어 필요한 API를 활용하시면 됩니다.
공통
API
협력사
API
상품
API
주문/배송
API
고객관리
API

API 서비스 방식

  • CJ온스타일 API 서비스 방식은 REST API로 제공합니다. 가장 대중적으로 사용되는 API 제공 방식으로서 사용자 접근성이 뛰어나고 개발이 편리합니다.
  • 언어에 종속적이지 않아 다양한 언어로 Client를 개발할 수 있습니다. 특정한 제약조건들이 존재하지 않기 때문에 자유롭게 Client 개발이 가능합니다.
  • CJ온스타일 에서는 주로 다음 2가지 방식으로 API를 제공하고 있습니다.
    • GET 방식으로 URI를 호출합니다. 데이터를 조회해야 하는 경우 주로 사용됩니다.
    • POST 방식으로 URI를 호출합니다. 데이터를 생성 해야하는 경우 많이 사용됩니다.
      (BODY에 값을 담아 전송 하시면 해당 데이터를 토대로 작업을 진행합니다.)
  • API 제공 형식은 JSON 형식을 지원하고 있습니다.
  • Header 값에 Accept 값과 Content-Type 값을 사용하여 JSON 형태로 서비스를 제공하고 있습니다.

표준 API 이용안내

API 인증키 발급절차

협력사 입점
파트너시스템
로그인
API 정보관리
기본정보 등록
셀러툴사 선택
및 IP 등록
API 인증키
발급

IP 관리 절차

  1. 1) ‘파트너시스템 > API 관리 > API 정보관리’ 메뉴에서 [IP관리] 영역에 IP를 등록합니다.
    1. 1-1) 직접 개발을 하는 경우에는 협력사의 개발서버/운영서버 IP를 각각 등록해주셔야 각 환경에 방화벽 허용을 할 수 있습니다.
    2. 1-2) 셀러툴/솔루션사를 통해 개발을 진행하는 경우에는 사전에 등록된 셀러툴사를 선택하면 별도의 방화벽 요청은 진행하지 않아도 됩니다.
  2. 2) 등록한 IP는 인프라팀에서 방화벽 허용을 진행해주며, 영업일 기준으로 2~3일 정도 소요될 수 있습니다.
  3. 3) IP가 추가/삭제되는 경우에는 위의 첫 번째 프로세스부터 다시 진행합니다.