사이드 메뉴
커뮤니케이션
API 제공
어드민 API
비즈 앱 관리
신규 어드민 API 제공
이 문서는 제공 종료된 구버전 어드민 API에 대해 안내합니다. 신규 어드민 API에 대한 자세한 내용은 신규 어드민 API 제공 안내에서 확인할 수 있습니다.
이 문서는 카카오디벨로퍼스 비즈 앱의 비즈 앱 정보에 대한 어드민 API 사용 방법을 안내합니다.
| 메서드 | 호스트 | 리소스 |
|---|---|---|
POST | internal-admin-kapi.kakao.com | /bizApp |
| 이름 | 설명 |
|---|---|
| FIND_ALL | 비즈 앱을 검색합니다. |
| UPDATE_ALL_BIZ_NUM | 지정한 비즈 앱의 사업자 등록번호를 일괄 수정합니다. |
비즈 앱을 검색합니다. 사업자 등록번호 또는 앱 ID 목록으로 비즈 앱을 조회하는 데 사용합니다.
요청 처리 성공 시 응답은 검색 조건에 해당하는 비즈 앱 정보의 배열을 payload에 포함합니다.
요청 페이로드
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| query.biz_app.app_id | Integer[] | 앱 ID 목록 중요: 요청 시 query.biz_app.app_id 또는 query.biz_app.biz_num 중 하나는 필수 전달해야 함 | O(Optional) |
| query.biz_app.biz_num | String | 앱의 사업자 등록번호 ( (\d{3})-(\d{2})-(\d{5}) 형식)중요: 요청 시 query.biz_app.app_id 또는 query.biz_app.biz_num 중 하나는 필수 전달해야 함 | O(Optional) |
| query.biz_app.biz_plus_friends | String | 앱의 비즈니스 채널 연결 여부(비즈 채널 앱 여부)TRUE: 연결FALSE: 미연결 | X |
| query.app.status | String | 앱의 상태, 아래 중 하나
| X |
응답 페이로드
BizApp의 배열
요청 예제
curl -v POST "https://internal-admin-kapi.kakao.com/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_ALL","payload": {"query.biz_app.app_id": [123456],"query.biz_app.biz_num": "000-00-99999","query.biz_app.biz_plus_friends": "FALSE","query.app.status": "ACTIVE"}}'
응답 예제
// 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"}]
Reponse Sample: 2개의 앱 ID로 검색, 일부 검색 조건을 만족하지 않는 앱을 제외한 1건의 응답만 반환
// 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-20T08:43:25Z"},"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[]
지정한 비즈 앱의 사업자 등록번호를 일괄 수정합니다.
요청 처리 성공 시 응답은 사업자 등록번호를 변경한 앱의 비즈 앱 정보 목록을 payload에 포함합니다.
요청 페이로드
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| biz_num | String | 변경할 사업자 등록번호 ( (\d{3})-(\d{2})-(\d{5}) 형식) | O |
| query.biz_app.app_id | Integer[] | 앱 ID 목록 | O |
| query.biz_app.biz_num | String | 앱의 사업자 등록번호 ( (\d{3})-(\d{2})-(\d{5}) 형식) | X |
| query.biz_app.biz_plus_friends | String | 앱의 비즈니스 채널 연결 여부(비즈 채널 앱 여부)TRUE: 연결FALSE: 미연결 | X |
| query.app.status | String | 앱의 상태, 아래 중 하나
| X |
응답 페이로드
BizApp의 배열
요청 예제
curl -v POST "https://internal-admin-kapi.kakao.com/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_ALL_BIZ_NUM","payload": {"biz_num": "000-00-00000","query.biz_app.app_id": [123456,987654]}}'
응답 예제
// 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-20T08:43:25Z"},"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"},{"biz_app": {"app_id": 987654,"biz_num": "000-00-00000","biz_plus_friends": "FALSE","created_at": "2022-01-18T11:21:05Z","updated_at": "2022-01-20T08:43:25Z"},"id": 987654,"name": "Test","company": "TestCompany","icon": "https://k.kakaocdn.net/14/dn/ZSgjMtZ8UD/VLGDXCc3JO2412f3S8v7lk/o.jpg","app_type": "DEFAULT","category": "Book_Reference","status": "ACTIVE","phase": "NORMAL"}]