1. 토큰 생성 API
POST /token/refresh
Refresh-Token 발행 (refreshToken)
Refresh-Token 은 Access-Token 발행을 위해 사용한다. (유효 기간: 1 주)
요청 파라미터 | |||||
키 | - | - | 타입 | 필수 | 설명 |
bizId | String | O | 비즈뿌리오 사용자 ID | ||
apiKey | String | O | 발급 받은 API Key | ||
반환 값 | |||||
키 | - | 타입 | 설명 | ||
code | String | 결과 코드 | |||
message | String | 실패 시 결과 메시지 | |||
data |
Object | 성공 시 데이터 | |||
accessToken | String | 인증 토큰 | |||
refreshToken | String | 리프레시 토큰 |
[Example] [Request] | ||
{ "bizId":"test_api001", "apiKey":"123cr0wSyabc" } |
||
[Example] [Response] | ||
{ "code": "200", "message": "요청 성공", "data": { "refreshToken": "…", "accessToken": "… " } } |
POST /token/access
Access-Token 발행 (accessToken)
Access-Token 은 API 인증을 위해 사용한다. (유효 기간: 4 시간)
요청 파라미터 | |||||||
키 | - | - | 타입 | 필수 | 설명 | ||
refreshToken | String | O | 리프레시 토큰 | ||||
반환 값 | |||||||
키 | - | 타입 | 설명 | ||||
code | String | 결과 코드 | |||||
message | String | 실패 시 결과 메시지 | |||||
refreshToken | String | 리프레시 토큰 | |||||
[Example] [Request] | |||||||
{ "refreshToken": "…" } |
|||||||
[Example] [Response] | |||||||
{ "code": "200", "message": "요청 성공", "data": { "accessToken": "…" } } |
2. 파트너 관리
POST /v1/partner/get
파트너 조회 (getPartner)
네이버 톡톡에 등록된 파트너(발송 계정) 정보를 조회합니다. 파트너 등록은 비즈뿌리오 웹에서만 가능합니다.
- 계정상태(accountStatusType)의 상태값은 다음과 같습니다.
- NORMAL (사용중)
- PAUSE (사용중지)
- SYSPAUSE (시스템사용중지)
- PREBLOCK (사용보류)
- BLOCK (사용제재)
- DELETED (삭제)
-H 'Content-Type: application/json'
-H 'Authorization: Bearer {{accessToken}}'
요청 파라미터 | |||||
키 | - | 타입 | 필수 | 설명 | |
naverPartnerKey | String | O |
네이버 톡톡 파트너 키 : 네이버톡톡 파트너센터에서 파트너 계정 생성 및 승인 받기 완료 후 |
||
반환 값 | |||||
키 | - | 타입 | 설명 | ||
code | String | 결과 코드 | |||
message | String | 실패 시 결과 메시지 | |||
data | Object | 성공 시 데이터 | |||
templateGroups | String | 그룹정보 | |||
name | String | 그룹명 | |||
templateGroupkey | String | 그룹키 | |||
templateCount | String | ||||
approved | integer | 검수완료 템플릿수 | |||
rejected | integer | 검수반려 템플릿수 | |||
pending | integer | 검수요청 템플릿수 | |||
registered | integer | 등록 템플릿수 | |||
account | String | ||||
profileName | String | 프로필명 | |||
accountStatus | String | 계정상태 | |||
accountStatusType | String | 계정상태 코드값 | |||
accountId | String | 톡톡계정 ID | |||
partnerKey | String | 파트너키 | |||
chatYn | String | 상담 기능 사용 | |||
businessTypeCategoryName | String | 업종분류 | |||
registerDate | String | 등록일 |
[Example] [Request] | ||
{ "naverPartnerKey" : "{{naverPartnerKey}}" } |
||
[Example] [Response] | ||
{ "code": "200", "message": "요청 성공", "data": { "templateGroups": [ { "name": "그룹 1", "templateGroupKey": "…" }, "name": "비즈뿌리오", "templateGroupKey": "." } ], "templateCount": { "approved": 260, "rejected": 260, "pending": 260, "registered": 260 }, "account": { "profileName": "다우기술", "accountStatus": "사용중", "accountStatusType": "NORMAL", "accountId": "…", "partnerKey": "…", "chatYn": true, "businessTypeCategoryName": "인터넷/통신 > 인터넷서비스", "registerDate": "2024.05.17. 14:09:27" } } } |
3. 파트너 그룹 관리
POST /v1/group/register
파트너 그룹 추가 (registerGroup)
파트너 그룹을 생성합니다.
그룹의 템플릿은 파트너의 템플릿과 별도로 관리됩니다.
여러 파트너들을 파트너 그룹으로 묶어, 그룹 템플릿을 사용할 수 있습니다.
-H 'Content-Type: application/json'
-H 'Authorization: Bearer {{accessToken}}'
요청 파라미터 | |||||||
키 | - | 타입 | 필수 | 설명 | |||
groupName | String | O | 그룹명 | ||||
반환 값 | |||||||
키 | - | 타입 | 설명 | ||||
code | String | 결과 코드 | |||||
message | String | 실패 시 결과 메시지 | |||||
data | Object | 성공 시 데이터 | |||||
name | String | 그룹명 | |||||
templateGroupKey | String | 그룹키 | |||||
[Example] [Request] | |||||||
{
} |
"groupName": "TP-GROUP-TEST |
||||||
[Example] [Response] | |||||||
{
} |
"code": "200", "message": "요청 성공", "data": { "name": "TP-GROUP-TEST", "templateGroupKey": "…" } |
POST /v1/group/add/partner
파트너 그룹에 파트너 추가 (addPartner)
파트너 그룹에 파트너를 추가합니다.
추가된 파트너는 그룹 템플릿을 사용할 수 있습니다.
-H 'Content-Type: application/json'
-H 'Authorization: Bearer {{accessToken}}'
요청 파라미터 | |||||||
키 | - | 타입 | 필수 | 설명 | |||
templateGroupKey | String | O | 그룹키 | ||||
naverPartnerId | String | O | 파트너 ID | ||||
반환 값 | |||||||
키 | - | 타입 | 설명 | ||||
code | String | 결과 코드 | |||||
message | String | 실패 시 결과 메시지 | |||||
data | Object | 성공 시 데이터 | |||||
name | String | 그룹명 | |||||
templateGroupKey | String | 그룹키 | |||||
naverPartners | String | 파트너 ID 리스트 | |||||
[Example] [Request] | |||||||
{ | |||||||
"templateGroupKey": "{{templateGroupKey}}", | |||||||
"naverPartnerId": "{{naverPartnerId}}" | |||||||
} | |||||||
[Example] [Response] | |||||||
{ |
"code": "200", "message": "요청 성공", "data": { "name": "TP-GROUP-TEST", "templateGroupKey": "…", " naverPartners": [ "{{naverPartnerId}}" ] } |
||||||
} |
POST /v1/group/remove/partner
파트너 그룹에 파트너 제거 (removePartner)
파트너 그룹에 존재하는 네이버 파트너를 제거합니다.
-H 'Content-Type: application/json'
-H 'Authorization: Bearer {{accessToken}}'
요청 파라미터 | |||||||
키 | - | 타입 | 필수 | 설명 | |||
templateGroupKey | String | O | 그룹키 | ||||
naverPartnerId | String | O | 파트너 ID | ||||
반환 값 | |||||||
키 | - | 타입 | 설명 | ||||
code | String | 결과 코드 | |||||
message | String | 실패 시 결과 메시지 | |||||
data | Object | 성공 시 데이터 | |||||
name | String | 그룹명 | |||||
templateGroupKey | String | 그룹키 | |||||
naverPartners | String | 파트너 ID 리스트 | |||||
[Example] [Request] | |||||||
{ | |||||||
"templateGroupKey": "{{templateGroupKey}}", | |||||||
"naverPartnerId": "{{naverPartnerId}}" | |||||||
} | |||||||
[Example] [Response] | |||||||
{ |
"code": "200", "message": "요청 성공", "data": { "name": "TP-GROUP-TEST", "templateGroupKey": "…", " naverPartners": [ "{{naverPartnerId}}" ] } |
||||||
} |
댓글
댓글 0개
이 문서에는 댓글을 달 수 없습니다.