사이드 메뉴
커뮤니케이션
API 제공
어드민 API
내 애플리케이션: 비즈 앱
신규 어드민 API 제공
이 문서는 제공 종료된 구버전 어드민 API에 대해 안내합니다. 신규 어드민 API에 대한 자세한 내용은 신규 어드민 API 제공 안내에서 확인할 수 있습니다.
이 문서는 카카오디벨로퍼스 앱(애플리케이션)의 비즈 앱 정보에 대한 어드민 API 사용 방법을 안내합니다.
각 제목에 부착된 태그(Tag)는 아래와 같은 의미입니다.
| 태그 | 설명 |
|---|---|
Internal | 이 액션은 API플랫폼 내부에서만 사용합니다. |
:app_id부분에 요청 대상 앱 ID를 입력해야 합니다.
| 메서드 | 호스트 | 리소스 |
|---|---|---|
POST | internal-admin-kapi.kakao.com | /app/:app_id/bizApp |
| 이름 | 설명 |
|---|---|
| FIND | 앱의 비즈 앱 정보를 조회합니다. |
| CREATE | 앱을 비즈 앱으로 전환합니다. |
| UPDATE Internal | 앱의 비즈 앱 정보를 수정합니다. |
| UPDATE_BIZ_NUM | 비즈 앱의 사업자 등록번호를 변경합니다. |
| UPDATE_BIZ_CHANNEL_APP | 앱의 비즈니스 채널 연결 설정을 변경합니다. |
| DELETE | 비즈 앱을 일반 앱으로 전환합니다. |
앱의 비즈 앱 정보를 조회합니다.
요청 처리 성공 시 응답은 앱 기본 정보와 비즈 앱 정보를 payload에 포함합니다.
요청 페이로드
- 없음
응답 페이로드
요청 예제
curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/bizApp" \-H "Content-Type: application/json; charset=utf-8" \-H "ADMIN-API-META-RENDER: simple" \-u "${GROUP_NAME}:${GROUP_TOKEN}" \-H "ADMIN-API-USERID: ${USER_INFO}" \-d $'{"name": "FIND"}'
응답 예제
// HTTP/2 200{"biz_app": {"app_id": 123456,"biz_num": "000-00-00000","biz_plus_friends": "FALSE","created_at": "2022-01-17T10:28:59Z","updated_at": "2022-01-17T10:28:59Z"},"id": 123456,"name": "Sample","company": "SampleCompany","icon": "https://k.kakaocdn.net/14/dn/ZSfZPxO70E/DJNC0WsJym1OoiMmo8K5O1/o.jpg","app_type": "KAKAO","category": "Book_Reference","status": "ACTIVE","phase": "NORMAL"}}
응답 예제: 사업자 등록번호가 없는 비즈 앱
// HTTP/2 200{"biz_app": {"app_id": 123456,"biz_plus_friends": "FALSE","created_at": "2022-01-17T10:28:59Z","updated_at": "2022-01-18T10:38:36Z"},"id": 123456,"name": "Sample","company": "SampleCompany","icon": "https://k.kakaocdn.net/14/dn/ZSfZPxO70E/DJNC0WsJym1OoiMmo8K5O1/o.jpg","app_type": "KAKAO","category": "Book_Reference","status": "ACTIVE","phase": "NORMAL"}
응답 예제: 요청 처리 실패, 비즈 앱이 아닌 일반 앱을 대상으로 요청한 경우
// HTTP/2 404{"message": "${MESSAGE}"}
앱을 비즈 앱으로 전환합니다.
이미 비즈 앱인 경우, 이 액션으로 사업자 등록번호를 추가하거나 변경할 수는 없습니다. 사업자 등록번호 등록은 UPDATE_BIZ_NUM 액션으로 요청합니다.
요청 처리 성공 시 응답은 앱의 기본 정보와 비즈 앱 정보를 payload에 포함합니다. 이미 비즈 앱인 앱을 대상으로 요청한 경우, 비즈 앱 정보 변경이나 에러 발생 없이 응답을 반환합니다.
요청 페이로드
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| biz_num | String | 사업자 등록번호 사업자 등록번호 값을 전달하지 않을 경우, 사업자 등록번호 없는 비즈 앱이 됨 ( (\d{3})-(\d{2})-(\d{5}) 형식) | X |
응답 페이로드
요청 예제
curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/bizApp" \-H "Content-Type: application/json; charset=utf-8" \-H "ADMIN-API-META-RENDER: simple" \-u "${GROUP_NAME}:${GROUP_TOKEN}" \-H "ADMIN-API-USERID: ${USER_INFO}" \-d $'{"name": "CREATE","payload": {"biz_num": "000-00-00000"}}'
응답 예제
// HTTP/2 200{"biz_app": {"app_id": 123456,"biz_num": "000-00-99999","biz_plus_friends": "FALSE","created_at": "2022-01-18T11:21:05Z","updated_at": "2022-01-18T11:21:05Z"},"id": 123456,"name": "Sample","company": "SampleCompany","icon": "https://k.kakaocdn.net/14/dn/ZSgjMtZ8UD/VLGDXCc3JO2412f3S8v7lk/o.jpg","app_type": "DEFAULT","category": "Book_Reference","status": "ACTIVE","phase": "NORMAL"}
앱의 비즈 앱 정보를 수정합니다. 이 액션은 의도하지 않은 사이드 이펙트(Side effect)를 일으킬 우려가 있으므로, 가급적 UPDATE_BIZ_NUM, UPDATE_BIZ_CHANNEL_APP를 사용할 것을 권장합니다.
payload 하위 파라미터로 수정할 비즈 앱 정보를 전달합니다. biz_plus_friends 값은 수정할 수 없으므로 FIND 응답과 동일한 값을 사용해야 합니다.
요청 처리 성공 시 응답은 앱의 기본 정보와 비즈 앱 정보를 payload에 포함합니다.
요청 페이로드
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| biz_num | String | 사업자 등록번호 사업자 등록번호 값을 전달하지 않을 경우, 사업자 등록번호 없는 비즈 앱이 됨 ( (\d{3})-(\d{2})-(\d{5}) 형식) | X |
| biz_plus_friends | String | 비즈니스 채널 연결 여부(비즈 채널 앱 여부)TRUE: 연결FALSE: 미연결(기본값: FALSE)중요: 수정 불가, FIND 응답의 biz_plus_friends 값과 일치해야 함 | X |
응답 페이로드
요청 예제
curl -v POST "https://alpha-internal-admin-kapi.kakao.com/app/:app_id/bizApp" \-H "Content-Type: application/json; charset=utf-8" \-H "ADMIN-API-META-RENDER: simple" \-u "${GROUP_NAME}:${GROUP_TOKEN}" \-H "ADMIN-API-USERID: ${USER_INFO}" \-d $'{"name": "UPDATE","payload": {"biz_num": "000-00-00000","biz_plus_friends": "TRUE"}}'
응답 예제
// HTTP/2 200{"biz_app": {"app_id": 977071,"biz_num": "000-00-00000","biz_plus_friends": "TRUE","created_at": "2022-10-31T10:11:59Z","updated_at": "2023-01-04T02:40:01Z"},"id": 977071,"name": "Sample","company": "SampleCompany","icon": "https://k.kakaocdn.net/14/dn/ZSfZPxO70E/DJNC0WsJym1OoiMmo8K5O1/o.jpg","app_type": "KAKAO","category": "Book_Reference","status": "ACTIVE","phase": "NORMAL"}
비즈 앱의 사업자 등록번호를 변경합니다. 이 액션은 비즈 앱을 대상으로만 요청할 수 있습니다.
요청 처리 성공 시 응답은 변경된 앱의 비즈 앱 정보를 payload에 포함합니다.
요청 페이로드
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| biz_num | String | 사업자 등록번호 사업자 등록번호 값을 전달하지 않을 경우, 사업자 등록번호 없는 비즈 앱이 됨 ( (\d{3})-(\d{2})-(\d{5}) 형식) | X |
응답 페이로드
요청 예제
curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/bizApp" \-H "Content-Type: application/json; charset=utf-8" \-H "ADMIN-API-META-RENDER: simple" \-u "${GROUP_NAME}:${GROUP_TOKEN}" \-H "ADMIN-API-USERID: ${USER_INFO}" \-d $'{"name": "UPDATE_BIZ_NUM","payload": {"biz_num": "000-00-99999"}}'
응답 예제
// HTTP/2 200{"biz_app": {"app_id": 123456,"biz_num": "000-00-99999","biz_plus_friends": "FALSE","created_at": "2022-01-18T10:47:19Z","updated_at": "2022-01-18T10:50:23Z"},"id": 123456,"name": "Sample","company": "SampleCompany","icon": "https://k.kakaocdn.net/14/dn/ZSgjMtZ8UD/VLGDXCc3JO2412f3S8v7lk/o.jpg","app_type": "DEFAULT","category": "Book_Reference","status": "ACTIVE","phase": "NORMAL"}
응답 예제: 요청 처리 실패, 비즈 앱이 아닌 일반 앱을 대상으로 요청한 경우
// HTTP/2 404{"message": "${MESSAGE}"}
앱의 비즈니스 채널 연결 설정을 변경합니다. 이 액션은 비즈 앱을 대상으로만 요청할 수 있습니다. 또한 이 액션으로는 앱의 비즈니스 채널 연결 여부 설정만 가능하며, 특정 비즈니스 채널과 연결하거나 연결을 해제할 수는 없습니다.
요청 처리 성공 시 응답은 앱의 변경된 비즈 앱 정보를 payload에 포함합니다.
요청 페이로드
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| biz_plus_friends | String | 비즈니스 채널 연결 여부(비즈 채널 앱 여부)TRUE: 연결FALSE: 미연결(기본값: FALSE)참고: 연결된 비즈니스 채널이 없더라도 값이 TRUE일 수 있음 | X |
응답 페이로드
요청 예제
curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/bizApp" \-H "Content-Type: application/json; charset=utf-8" \-H "ADMIN-API-META-RENDER: simple" \-u "${GROUP_NAME}:${GROUP_TOKEN}" \-H "ADMIN-API-USERID: ${USER_INFO}" \-d $'{"name": "UPDATE_BIZ_CHANNEL_APP","payload": {"biz_plus_friends": "TRUE"}}'
응답 예제
// HTTP/2 200{"app_id": 123456,"biz_num": "000-00-00000","biz_plus_friends": "TRUE","created_at": "2022-01-18T10:58:55Z","updated_at": "2022-01-18T11:02:06Z"}
응답 예제: 요청 처리 실패, 비즈 앱이 아닌 일반 앱을 대상으로 요청한 경우
// HTTP/2 404{"message": "${MESSAGE}"}
비즈 앱을 일반 앱으로 전환합니다. 이 액션은 비즈 앱을 대상으로만 요청할 수 있습니다.
요청 처리 성공 시 응답은 앱의 기본 정보 및 기존의 비즈 앱 정보를 payload에 포함합니다.
요청 페이로드
- 없음
응답 페이로드
요청 예제
curl -v POST "https://internal-admin-kapi.kakao.com/app/:app_id/bizApp" \-H "Content-Type: application/json; charset=utf-8" \-H "ADMIN-API-META-RENDER: simple" \-u "${GROUP_NAME}:${GROUP_TOKEN}" \-H "ADMIN-API-USERID: ${USER_INFO}" \-d $'{"name": "DELETE"}'
응답 예제
// HTTP/2 200{"biz_app": {"app_id": 123456,"biz_num": "000-00-00000","biz_plus_friends": "FALSE","created_at": "2022-01-18T10:47:19Z","updated_at": "2022-01-18T10:50:23Z"},"id": 123456,"name": "Sample","company": "SampleCompany","icon": "https://k.kakaocdn.net/14/dn/ZSgjMtZ8UD/VLGDXCc3JO2412f3S8v7lk/o.jpg","app_type": "DEFAULT","category": "Book_Reference","status": "ACTIVE","phase": "NORMAL"}
응답 예제: 요청 처리 실패, 비즈 앱이 아닌 일반 앱을 대상으로 요청한 경우
// HTTP/2 404{"message": "${MESSAGE}"}