이 문서는 서비스에서 어드민 API를 사용해 필요한 기능을 구현하는 방법을 안내합니다. 각 항목을 참고해 카카오디벨로퍼스 앱(애플리케이션), 개발자 계정 관리 기능을 서비스에 구현할 수 있습니다.

어드민 API는 권한이 있어야 사용 가능합니다. 리소스 목록과 각 개발 문서에서 필요한 기능 제공 여부 확인 후 사용 신청합니다. 사용 신청 시 아래 정보를 전달하면 보다 자세한 안내가 가능합니다.

• 2차 인증 사용 여부
  • 아래와 같은 경우 2차 인증으로 사용자 인증 필요
    • 데이터 수정 기능을 사용하려는 경우
    • 앱 키 등 민감 정보를 조회하려는 경우
  • 권장 인증 타입 참고
• 어드민 API 사용 시나리오
  • 서비스에 필요한 기능이나 데이터 목록
  • 어드민 API 호출 시 사용하려는 계정 정보 유형

이 문서에 안내된 기능 구현 시에는 아래 인증 타입 사용을 권장합니다.

KAKAO_BY_ACCESS_TOKEN 또는 APP_BY_APP_KEY 사용이 불가능한 경우, 대표 계정(대표 개발자 계정)을 2차 인증에 사용할 수 있습니다. 대표 계정 사용 시 인증 타입은 DEVELOPER를 사용합니다. 서비스 관리를 위한 공용 사내계정을 대표 계정으로 등록하고, 대표 계정 ID로 모든 요청에 대한 2차 인증을 수행할 수 있습니다. 단, 사용자가 개발자 웹사이트에서 대표 계정을 팀원에서 내보낼 경우, 어드민 API로 해당 앱 관리가 불가능합니다.

서비스에서 개발자 계정을 등록해야 할 경우, 개발자 웹사이트에서 개발자 계정을 등록하도록 안내합니다. 개발자 계정 등록 페이지는 등록 완료 시 서비스 페이지 URL로 302 리다이렉트(Redirect)하는 continue 옵션을 지원합니다. 아래 예시를 참고합니다.

https://developers.kakao.com/register?continue=https%3A%2F%2Fdevelopers.kakao.com%2F

통합 서비스 약관 및 통합 계정 사용 서비스의 경우에는 통합 계정 가입 시 개발자 웹사이트 개발자 계정도 자동 등록되므로 별도 등록 절차가 불필요합니다.

개발자 웹사이트의 앱은 특정 서비스 관련 앱이라는 정보를 저장하지 않으므로, 특정 앱이 서비스에서 관리하는 앱인지 알 수 없습니다. 전체 사용자의 앱 목록을 관리해야 한다면 아래 중 한 가지 방법으로 서비스 사용자의 앱인지 식별하고 관리할 수 있습니다.

• 사용자 앱 목록 별도 관리
  • 앱 등록 시 앱 ID, 앱 키, 액세스 토큰, ID 토큰 등을 별도 저장해 사용
    • 액세스 토큰이나 ID 토큰 사용 시: WHOAMI로 해당 사용자의 개발자 계정 ID 확인 후, 팀원으로 참여 중인 앱 목록 조회 가능
    • 앱 ID나 앱 키 사용 시: 각 앱 정보 앱 ID 또는 앱 키로 조회 가능
• 대표 계정을 모든 사용자 앱의 팀원으로 등록
  • 대표 계정은 각 사용자 앱의 팀원(EDITOR)으로 등록돼 있어야 함

사용자가 개발자 웹사이트에서 앱을 삭제하면 서비스에서 관리하는 사용자 앱 목록과 실제 앱 존재 여부가 일치하지 않을 수 있습니다. 또한 개발자 웹사이트와 어드민 API는 개발자 계정당 최대 1,000개 앱의 목록만 제공합니다. 이 경우, 앱 ID를 알고 있다면 아래 URL로 앱 정보를 확인할 수 있습니다.

// ...app_id에 조회할 앱 ID 입력
https://developers.kakao.com/console/app/:app_id

서비스에서 어드민 API로 개발자 웹사이트 앱을 등록(생성), 수정하는 기능을 구현할 수 있습니다.

서비스 사용자 소유의 사용자 앱을 등록합니다. 등록될 앱의 앱 이름, 회사명(상호, 법인 또는 단체명), 앱 아이콘 정보를 파라미터로 전달해야 합니다. owner_developer_id 파라미터 값은 액세스 토큰에 해당하는 사용자(로그인한 사용자)의 개발자 계정 ID를 사용합니다.

2차 인증에 DEVELOP 인증 타입과 대표 계정을 사용할 경우, 아래 순서로 앱을 등록합니다.

1. 대표 계정 소유의 앱 등록
   • owner_developer_id 파라미터 값으로 대표 계정의 개발자 계정 ID 사용
2. 앱 소유자 변경
   • 대표 계정이 소유할 수 있는 앱의 수에 제한이 있으므로 앱 소유자 변경 필수
   • 사용자의 개발자 계정을 사용자 앱에 팀원 추가 후, 팀원 수정으로 실제 앱 사용자로 소유자 변경

사용자 앱의 기본 정보와 플랫폼 정보, 앱 키에 대한 수정을 요청할 수 있습니다. 앱 수정 기능은 여러 API와 Action으로 나눠져 있으므로 각 문서를 참고합니다.

서비스에서 어드민 API로 사용자 앱의 팀원을 추가, 수정할 수 있습니다. 팀원 수정으로 앱 소유자(OWNER) 변경도 가능합니다. 자세한 안내는 멤버를 참고합니다.

사용자 앱에 팀원을 추가합니다. 팀원 추가 시에는 소유자 외의 권한(role)만 부여할 수 있습니다. 팀원 추가 시, 구현하려는 기능에 따라 사용해야 할 API가 다릅니다. 아래 내용을 참고합니다.

• 앱 소유자 변경을 위한 팀원 추가
  • 개발자 계정 등록이 완료된 사용자만 앱 소유자가 될 수 있음
  • 개발자 계정 등록을 완료한 사용자만 팀원으로 추가할 수 있는 /app/:app_id/developer/:developer_id API의 ADD 사용
• 앱 조회 및 관리를 위한 공동 사용자 추가
  • 대상 사용자가 소유자 이외의 권한만 사용(EDITOR, READER)
  • 개발자 계정을 등록하지 않은 사용자도 초대할 수 있는 /app/:app_id/developer API의 ADD 사용

팀원의 권한(role)을 수정합니다. 대상 팀원의 권한을 앱 소유자(OWNER)로 변경 시, 대상 사용자가 개발자 계정 등록을 완료한 상태여야 합니다. 개발자 계정 상태는 /developer/:developer_id API의 FIND_STATUS로 확인할 수 있습니다.

사용자 앱에 카카오 API 호출 기능을 제공하는 데 필요한 어드민 API를 안내합니다.

어드민 API를 사용해 사용자 앱의 플랫폼 정보를 등록할 수 있습니다. 카카오 API는 사용자 앱에 등록된 플랫폼에서만 호출 가능합니다. 예를 들어, 카카오톡 공유는 사용자 앱의 Web 플랫폼에 등록된 도메인에서만 동작합니다. 자세한 안내는 플랫폼 등록을 참고합니다.

어드민 API로 사용자 앱의 앱 키를 조회할 수 있습니다. 앱 키는 사용자 앱에서 카카오 API 호출 시 필요합니다. 구현 방식에 따라 사용해야 할 앱 키의 종류가 다르므로 각 제품 문서를 함께 참고합니다. 아래는 주요 제품 문서 목록입니다.

• 카카오톡 소셜: 카카오톡 프로필, 친구 피커
• 카카오톡 메시지
• 카카오톡 공유
• 푸시 알림

사용자 앱에 카카오 로그인 기능을 제공하는 데 필요한 어드민 API를 안내합니다.

어드민 API로 사용자 앱의 카카오 로그인 기능을 활성화할 수 있습니다.

어드민 API로 사용자 앱의 리다이렉트 URI 등록이 가능합니다. 웹 환경의 사용자 앱에서 카카오 로그인을 사용하려면 리다이렉트 URI 등록이 필요합니다. 자세한 안내는 카카오 로그인 과정을 참고합니다.

어드민 API로 사용자 앱의 카카오 로그인 동의항목을 설정할 수 있습니다. FIND_ALL로 사용자 앱에 설정 가능한 동의항목 목록을 조회하고, UPDATE로 필요한 동의항목을 사용하도록 설정합니다.