이 섹션의 문서

API 공통 인증 헤더 구성

1) 공통 인증 헤더 상세

카카오쇼핑의 모든 API 호출 시에는 모두 같은 타입의 공통 인증 요청 헤더가 사용되며, 헤더 정보를 포함하여 요청해야 합니다.

인증에 사용되는 APP KEY는 사전셋팅 과정에서 채번한 REST API KEY, ADMIN KEY를 사용하므로, 미비한 정보가 있다면 이전 과정을 다시 확인해주세요.

Host: kapi.kakao.com
Authorization: KakaoAK {admin_app_key}
Target-Authorization: KakaoAK {seller_app_key}
channel-ids: {channel_ids}
헤더 값 설명 비고
admin_app_key 연동대행사앱 ADMIN 키

[참고] 카카오 디벨로퍼스 API 인증키 발급 >
seller_app_key 판매자 API 인증키
(REST API 키)		 상동
channel_ids 연동하고자 하는 판매채널 id

- 톡스토어 : channel-ids=101

- 선물하기 : channel-ids=1

- 톡스토어, 선물하기 동시 호출 : channel-ids=1,101

- 특별히 요구되지 않는 경우 : 미기재

 

※ 주의사항

{
	"msg": "appKey(판매자인증키) is already deactivated",
	"code": -401
}

위와 같은 에러는 Target-Authorization의 "seller_app_key"가 변경되는 등 더 이상 유효하지 않은 상황에 발생합니다. 이 경우, 해당 판매자의 인증키가 맞는지 다시 한 번 확인해주세요.

- 경로 : 카카오쇼핑 판매자센터 > 가입한 판매채널의 [정보관리] > 판매채널 정보 > API 인증키

 

FAQ. 정상적으로 공통 헤더를 구성했는데 API가 호출되지 않습니다.
공통 인증 헤더 구성 후 API 호출 시 정상적으로 응답되지 않는 경우 다음의 정보를 먼저 확인해주세요.

1) Authorizaiton과 Target-Authorization에 각각 REST API KEY, ADMIN KEY를 입력하였더라도 같은 앱의 정보를 입력하면 아래와 같은 메세지가 리턴됩니다.

{"msg":"invalid authorization or target-authorization header.","code":-2}

판매자와 연동대행사의 애플리케이션을 분리하고 각각의 정보를 입력하여야 정상적으로 인증이 통과되므로 사전 세팅 과정의 계정 및 애플리케이션 분리를 다시 한번 확인해주세요.
[참고] 연동대행사 등록하기 >

2) 공통 인증 헤더를 구성 후 상품/주문 관련 API를 호출하려면 연동대행사와 판매자 연결이 선행되어야합니다.
[참고] 연동대행사와 판매자 연결하기 >

 

2) 판매채널(서비스) 별 API 호출방법과 호출권한 부여

카카오쇼핑 API는 카카오톡 스토어, 카카오톡 선물하기 모두 사용할 수 있습니다.
각 API 를 사용하려면 호출 대상 서비스를 채널구분(channel-ids) 파라미터 를 입력하여 호출합니다.

- 톡스토어 : channel-ids=101

- 선물하기 : channel-ids=1

- 톡스토어, 선물하기 동시 호출 : channel-ids=1,101

- 특별히 요구되지 않는 경우 : 미기재

톡스토어 API 권한은 API KEY 발급 시 기본적으로 부여되나, 선물하기 API 권한은 사전 협의된 판매자에 한해 선택적으로 부여됩니다.

- 톡스토어만 운영하거나 톡스토어 API 권한만 보유한 판매자인 경우:
채널 파라미터 기재가 필요한 API호출 시 꼭 채널 파라미터를 channel-ids=101 로 세팅하여 호출해 주세요.

- 선물하기 채널의 데이터를 불러가는 API를 호출하는 경우:
카카오쇼핑 판매자센터 내에서 API 호출 대상 서비스의 API 호출권한이 없으면 해당 서비스의 API 호출이 불가하므로 사전에 담당MD 혹은 담당자에게 선물하기 API 호출 권한 부여신청을 선행해주시기 바라며, 이미 신청한 경우라면 담당자에게 부여 여부를 확인해 주세요.

 
아래 경로에서 판매자 API 접근 허용여부를 확인할 수 있습니다.
- 경로 : 카카오쇼핑 판매자센터 > 가입한 판매채널의 [정보관리] > 판매채널 정보 > API 인증키

 

만약 위 내용대로 적용 시, 정상적으로 진행이 되지 않으면 아래 가이드를 참고해 주세요.

- [참고] 연동대행사와 판매자 연결하기 >

- [참고] 응답 코드 및 에러 코드 >

 

관련 문서