본문 바로가기메인 메뉴 바로가기사이드 메뉴 바로가기

kakao developers

관련사이트

사이드 메뉴

오픈 문서

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

인공지능

플랫폼 API

API 제공

전용 API

어드민 API

더 보기

어드민 API

신규 어드민 API 제공

이 문서는 제공 종료된 구버전 어드민 API에 대해 안내합니다. 신규 어드민 API에 대한 자세한 내용은 신규 어드민 API 제공 안내에서 확인할 수 있습니다.

기능 소개

어드민 API는 카카오 API 플랫폼의 앱, 개발자 계정 등 데이터를 API로 조회 및 수정하는 기능을 제공합니다. 어드민 API를 사용해 카카오디벨로퍼스를 거치지 않고도 각 서비스 관리자 웹사이트에서 앱을 등록, 조회, 수정하는 기능을 구현할 수 있습니다.

이용 정책

모든 어드민 API는 사내망에서만 호출 가능합니다.

또한 어드민 API는 API 사용 신청으로 필요한 권한을 받아야 사용할 수 있습니다. 어드민 API의 권한은 API, 액션, 페이로드 단위로 각각 제어 가능합니다. 권한 설정으로 페이로드의 일부 선택 파라미터를 필수 파라미터로 강제하거나, 특정 파라미터는 사용할 수 없도록 제한할 수 있습니다.

어드민 API는 KAUTH 및 KAPI와 규격이 다르므로, 레퍼런스를 참고해 인증, 요청, 응답 등 상세 정보를 확인하고 사용해야 합니다.

주의 사항

  • 어드민 API는 최종 사용자(End user) 서비스에서 사용할 수 없습니다.
  • 트래픽이 많은 서비스에서 어드민 API 사용 시에는 캐시(Cache) 사용을 고려합니다.
  • 장기간 사용하지 않은 API는 권한이 회수됩니다.
  • 어드민 API의 응답 모델은 필드가 추가될 수 있습니다.

사용 신청

어드민 API를 사용하기 위해서는 API 사용 신청이 필요합니다. [서비스] API플랫폼 아지트에서 사용 신청합니다. 신청 시 아래 정보를 전달합니다.

항목설명
활용 업무서비스 어드민에서 어드민 API로 구현하려는 기능에 대한 상세 정보

예시:
XXX 서비스 어드민 페이지에서 사용자가 등록한 앱 목록을 조회하는 기능을 제공하려고 합니다.
신규 그룹 생성 여부어드민 API 신규 사용처라면 O
기존 어드민 API 사용처인 경우 X
그룹 정보기존 어드민 API 사용처인 경우, 사용 신청하려는 리소스의 권한을 부여 받을 그룹 이름
요청 API 및 액션사용 신청하려는 리소스 및 액션 정보
사용 가능한 리소스 종류는 리소스 목록 참고
액션 종류는 각 API 개발 문서에서 확인 가능
예시:
/app
  • FIND_SIMPLE_APP_BY_APP_KEY
  • CREATE_WITH_DEFAULT
/app/:app_id
  • FIND_SIMPLE_APP
기타사용 문의 및 특이 사항

API 사용 신청 완료 후, API플랫폼에서는 사용처를 위한 그룹, 권한 등을 처리해 어드민 API 사용에 필요한 정보를 안내합니다.

리소스 목록

내 애플리케이션: 앱 설정

리소스호스트메서드이름
/appinternal-admin-kapi.kakao.comPOST앱
/app/:app_idinternal-admin-kapi.kakao.comPOST앱 정보
/app/:app_id/appKeyinternal-admin-kapi.kakao.comPOST앱 키
/app/:app_id/platforminternal-admin-kapi.kakao.comPOST플랫폼
/app/:app_id/platform/androidinternal-admin-kapi.kakao.comPOST플랫폼: Android
/app/:app_id/platform/iosinternal-admin-kapi.kakao.comPOST플랫폼: iOS
/app/:app_id/platform/webinternal-admin-kapi.kakao.comPOST플랫폼: Web

내 애플리케이션: 팀원

리소스호스트메서드이름
/app/:app_id/developerinternal-admin-kapi.kakao.comPOST팀원 관리
/app/:app_id/developer/:developer_idinternal-admin-kapi.kakao.comPOST개별 팀원 관리

내 애플리케이션: 카카오 로그인

리소스호스트메서드이름
/app/:app_id/oauthinternal-admin-kapi.kakao.comPOST카카오 로그인 기본 설정
/app/:app_id/user/managementinternal-admin-kapi.kakao.comPOST카카오 로그인 추가 설정
/app/:app_id/oauth/kakaoTalkChannel internal-admin-kapi.kakao.comPOST카카오톡 채널
/app/:app_id/scopeinternal-admin-kapi.kakao.comPOST동의항목
/app/:app_id/scope/:scope_codeinternal-admin-kapi.kakao.comPOST동의항목 정보 관리
/app/:app_id/oauth/clientSecretinternal-admin-kapi.kakao.comPOSTClient Secret
/app/:app_id/oauth/foreigninternal-admin-kapi.kakao.comPOST개인정보 국외이전
/app/:app_id/oauth/foreign/:idinternal-admin-kapi.kakao.comPOST개인정보 국외이전 동의항목
/app/:app_id/oauth/sseConfiginternal-admin-kapi.kakao.comPOST보안 이벤트 구독
/app/:app_id/oauth/plugininternal-admin-kapi.kakao.comPOST1회성 제공 동의

내 애플리케이션: 카카오싱크

리소스호스트메서드이름
/app/:app_id/oauth/easySignUpinternal-admin-kapi.kakao.comPOST간편가입
/app/:app_id/oauth/easySignUp/serviceTermsinternal-admin-kapi.kakao.comPOST서비스 약관
/app/:app_id/oauth/serviceTerms/:service_terms_idinternal-admin-kapi.kakao.comPOST개별 서비스 약관 관리
/app/:app_id/ecpAppinternal-admin-kapi.kakao.comPOSTECP 앱 관리

내 애플리케이션: 사용자

리소스호스트메서드이름
/app/:app_id/userinternal-admin-kapi.kakao.comPOST사용자 조회
/app/:app_id/userinternal-admin-kapi.kakao.comPOST사용자 ID 변환
/app/:app_id/userinternal-admin-kapi.kakao.comPOST사용자 및 사용자 프로퍼티
/app/:app_id/user/:idinternal-admin-kapi.kakao.comPOST개별 사용자 조회
/app/:app_id/user/propertyKeyinternal-admin-kapi.kakao.comPOST사용자 프로퍼티 키

내 애플리케이션: 비즈 앱

리소스호스트메서드이름
/app/:app_id/bizAppinternal-admin-kapi.kakao.comPOST비즈 앱 정보

내 애플리케이션: 서비스 설정

리소스호스트메서드이름
/app/:app_id/serviceinternal-admin-kapi.kakao.comPOST서비스
/app/:app_id/service/propertyinternal-admin-kapi.kakao.comPOST서비스: 상세

내 애플리케이션: 권한

리소스호스트메서드이름
/app/:app_id/permissioninternal-admin-kapi.kakao.comPOST권한 관리

내 애플리케이션: 메시지 템플릿

리소스호스트메서드이름
/app/:app_id/messageTemplateinternal-admin-kapi.kakao.comPOST메시지 템플릿 관리
/app/:app_id/messageTemplate/:template_idinternal-admin-kapi.kakao.comPOST개별 메시지 템플릿 관리

비즈 앱 관리

리소스호스트메서드이름
/bizAppinternal-admin-kapi.kakao.comPOST비즈 앱 관리

카카오게임 관리

리소스호스트메서드이름
/gameinternal-admin-kapi.kakao.comPOST게임 앱 관리
/game/:app_idinternal-admin-kapi.kakao.comPOST개별 게임 앱 관리

개발자 계정 관리

리소스호스트메서드이름
/developerinternal-admin-kapi.kakao.comPOST개발자 계정 관리
/developer/:developer_idinternal-admin-kapi.kakao.comPOST개발자 계정 상세 정보 관리
/developer/:developer_id/bizAppinternal-admin-kapi.kakao.comPOST개발자 계정별 비즈 앱 조회
/developer/:developer_id/bizApp/:app_idinternal-admin-kapi.kakao.comPOST개발자 계정별 비즈 앱 상세 정보 조회
/developer/:developer_id/dspAccountinternal-admin-kapi.kakao.comPOST개발자 계정별 통합 계정 정보 관리
/developer/:developer_id/blockinternal-admin-kapi.kakao.comPOST개발자 계정 차단

어드민 사용자 관리

리소스호스트메서드이름
/securityinternal-admin-kapi.kakao.comPOST보안: 사용자 확인

카카오계정 관리

리소스호스트메서드이름
/kakaoAccountinternal-admin-kapi.kakao.comPOST카카오계정 정보 조회

도움이 되었나요?