API Support Tool 안내

  • POSTMAN을 활용하시면 편리하게 API를 확인하고 사용하실 수 있습니다.

개발자센터에서 App을 등록하고 API를 사용하기 위한 필수정보를 입력합니다.

01

- 진행 화면 예시

POSTMAN 프로그램을 설치하고 API 컬렉션파일과 환경설정 파일을 다운로드 합니다.

02
  • POSTMAN 웹사이트에서 프로그램을 다운받습니다.   [POSTMAN 웹사이트 바로가기 ▶]
    POSTMAN 프로그램은 무료 버전의 사용이 가능하며 1일 1,000회까지 API를 테스트할 수 있습니다.
  • 카페24 API 컬렉션과 환경설정 파일을 다운로드합니다.[환경설정파일 다운로드 ▶]
    압축을 해제하시면 Cafe24 API Environment(Sample).postman_environment 파일이 제공됩니다.
  • 오른쪽 버튼을 클릭하면 카페24 API 컬렉션의 설치가 자동으로 가능합니다.

- 진행 화면 예시

다운받은 API 컬렉션 파일과 환경설정 파일을 POSTMAN에 적용합니다.

03
  • API 컬렉션 파일 적용방법
    페이지 상단의 버튼을 클릭하시면 API 컬렉션이 자동으로 적용됩니다.

  • 환경설정 파일 적용방법
    ① POSTMAN 프로그램의 오른쪽 상단의 버튼을 클릭한 후 '‘Manage Environment’를 클릭합니다.
    ② Manage Environment 팝업의 하단에 Import 버튼을 클릭한 후 다운로드 받은 environment 파일을 업로드 합니다.
    ③ 환경설정 선택 리스트에 ‘cafe24 API Environment(Sample)’ 라고 추가되었는지 확인합니다.
    ④ 추가된 ‘cafe24 API Environment(Sample)’ 클릭하여 환경설정 팝업을 오픈합니다.
    ⑤ mallid, domain, client_secret, client_id를 수정합니다.
    환경설정 파일 적용방법
    Key Value
    mallid 테스트 할 쇼핑몰 아이디
    redirect_uri 개발자센터에서 입력한 Redirect_URL(s)
    client_secret 개발자센터에서 발급받은 App secret key
    client_id 개발자센터에서 발급받은 App Key

- 진행 화면 예시

환경설정과 API 컬렉션이 준비되었으면 Access Token을 발급받습니다.

04
  • API 컬렉션에서 ‘Authorize Access Token’ 클릭합니다.
  • TYPE에서 ‘Oauth 2.0‘ 선택 후 ‘Get New Access Token’ 클릭합니다.
  • 팝업 화면에서 아래의 내용을 입력합니다. (빨강색 글자는 안내된 문구대로 그대로 입력)
    Access_Token 요청정보
    Key Value
    Token Name 발급받을 토큰의 이름 - 개발사에서 자유롭게 입력 가능
    Grant Type "Authorization Code“ 선택
    Callback URL {{redirect_uri}}
    - (수정하지 않고 그대로 입력)
    Auth URL https://{{mallid}}.cafe24api.com/api/v2/oauth/authorize
    - (수정하지 않고 그대로 입력)
    Access Token URL https://{{mallid}}.cafe24api.com/api/v2/oauth/token
    - (수정하지 않고 그대로 입력)
    Client ID {{client_id}}
    - (수정하지 않고 그대로 입력)
    Client Secret {{client_secret}}
    - (수정하지 않고 그대로 입력)
    Scope 요청하려는 API 권한 범위
    (예:mall.write_category,mall.write_order,mall.write_product,...)
    * 자세한 Scope 값은 API 권한(Scope) 가이드를 참고하여 주시기 바랍니다.
    State 위조 공격을 방지하기 위한 임의 값 - 개발사에서 자유롭게 입력 가능

- 진행 화면 예시

  • 모두 입력이 완료되었으면 ‘Request Token’ 클릭하면 쇼핑몰 로그인 화면이 나타나면 쇼핑몰 관리자 계정으로 로그인합니다.
  • 로그인이 성공하면 팝업을 통해 Access Token이 발급되면 Access Token과 하단의 Refresh Token을 확인하여 복사한 후 메모장 등에 붙여넣기하여 임시저장 합니다.
  • Postman 프로그램 오른쪽 상단에 버튼을 클릭하여 나타난 메뉴에서 Edit 버튼을 클릭합니다.
  • 복사한 Access Token을 'access_token' 항목에 붙여넣기 후 Update 버튼을 클릭합니다.

- 진행 화면 예시

Refresh Token을 적용하면 사용기간이 만료 후에도 편리하게 Token을 재발급 받아 API를 사용하실 수 있습니다.

05
  • POSTMAN 프로그램의 caef24 API Collection 중 'Authorize Access Token(Refresh Token)'을 선택합니다.
  • 개발자센터에서 발급받은 App key와 App secret key를 base64 인코딩을 이용하여 아래와 같은 형태로 변환합니다.
인코딩 포맷 : {{app key}:{{app secret key}}

예시) App key가 '111'이고 App secret key가 '222'인 경우 111:222 형태로 만들어 base64 인코딩

[base64 인코딩 지원사이트 바로가기 ▶]


  • 'grant_type'에 refresh_token 을 입력하고, 메모장 등에 복사해 둔 Refresh Token을 Body 탭의 'refresh_token'에 붙여넣기 한 후 Send 버튼을 클릭하면 Refresh Token을 취득할 수 있습니다.

  • 취득한 Refresh Token을 복사하여 POSTMAN 프로그램의 오른쪽 상단의 버튼과 Edit 버튼을 클릭하여 Manage Environment 팝업을 호출한 후 access_token에 붙여넣기 합니다.

이후 POSTMAN 프로그램에서 모든 API를 자유롭게 확인 및 사용할 수 있습니다.

06
  • 제공된 cafe24 API Collection에서 확인하고자 하는 API를 선택한 후 호출하시면 결과값을 확인할 수 있습니다.

- API 호출 예시(상품 리스트 조회 API)