서비스 흐름도

Notice

참고사항

해당 문서는 서비스에 대한 동작 흐름을 표시하는 문서입니다.
해당 문서에서 나오는 query 및 mutation API 정보는 상담하기 > 통합 문서에 GQL SDL Visialization을 참고해주세요. API 관련 사용 방법은 상담하기 > 인증키 사용 방법 샘플을 참고해주세요.

초기 설정

Header

Field Name	Type	Description
Content-type	String	application/json
x-mbi-partner-signature	String	Partner Credential을 사용하여 생성 (인증키 사용 방법 샘플)
x-mbi-app-signature	String	App Credential을 사용하여 생성 (인증키 사용 방법 샘플)
authorization	String	newAuthTokenByAppCredential을 통해 발급 받은 상담사 토큰

1. 고객사 가입

sequenceDiagram
  participant Partner
  participant Happytalk
  Partner ->>+ Happytalk: 사이트 생성 처리
  Note left of Partner: mutation Type 중<br/>addSiteByMbiPartner API 사용하여 사이트 생성 처리
  Happytalk -->>- Partner: 사이트 ID, 관리자 ID, App Credential 정보 반환

  Partner ->>+ Happytalk: 상담방 이벤트 구독 요청
  Note left of Partner: mutation Type 중<br/>subscribeRoomEvent API 사용하여 상담방 이벤트 구독 처리
  Happytalk -->>- Partner: 구독 처리 결과 반환

2. 신규 상담사 추가

sequenceDiagram
  participant Partner
  participant Happytalk
  Partner ->>+ Happytalk: 관리자 토큰 발급
  Note left of Partner: mutation Type 중<br/>newAuthTokenByAppCredential API 사용하여 발급
  Happytalk -->>- Partner: 관리자 Bearer 토큰 반환

  Partner ->>+ Happytalk: 허용된 계정 수, 활성화된 계정 수 조회
  Note left of Partner: query Type 중 site API를 사용하여<br/>activeAccountCount와 plan.currentPlan.accountLimit 정보 조회
  Happytalk -->>- Partner: 허용된 계정 수, 활성화된 계정 수 반환

  Partner ->>+ Happytalk: 허용 계정 수 변경 처리
  Note left of Partner: mutation Type 중 setAccountLimit API 사용하여 변경
  Happytalk -->>- Partner: 허용 계정 수 변경 처리 결과 반환

  Partner ->>+ Happytalk: 상담사 추가
  Note left of Partner: mutation Type 중 addCounselor API 사용하여 추가
  Happytalk -->>- Partner: 추가된 상담사 ID 정보 반환

신규 상담사 추가시 유의 사항

신규 상담사 추가 API 사용하여 상담사 추가 이후 추가된 상담사는 상담사 활성화 API를 통하여 활성화 이후 사용 가능합니다.

3. 해피톡 페이지 연결

해피톡 페이지 연결 과정에서 사용되는 HOST URL은 두가지 입니다.
1. 상담사 토큰 발급 URL 정보
2. Authorization URL 정보

sequenceDiagram
  participant Counselor
  participant Partner
  participant Happytalk
  Counselor ->>+ Partner: View 페이지 접근

  Partner ->>+ Happytalk: 상담사 토큰 발급
  Note left of Partner: mutation Type 중<br/>newAuthTokenByAppCredential API 사용하여 발급
  Happytalk -->>- Partner: 상담사 Bearer 토큰 반환

  Partner ->>+ Happytalk: Authorization code 발급
  Note left of Partner: mutation Type 중 newAuthorizationCode API 사용하여 코드 발급
  Happytalk -->>- Partner: Authorization code 반환<br/>(60초 후 만료) 

  Partner -->>- Counselor: 해피톡 Authorization URL

  Counselor ->>+ Happytalk: Authorization URL로 접근
  Happytalk -->>- Counselor: 302 Redirect

기타 설정

상담사 활성화

sequenceDiagram
  participant Partner
  participant Happytalk
  Partner ->>+ Happytalk: 관리자 토큰 발급
  Note left of Partner: mutation Type 중<br/>newAuthTokenByAppCredential API 사용하여 발급
  Happytalk -->>- Partner: 관리자 Bearer 토큰 반환

  Partner ->>+ Happytalk: 상담사 활성화 처리
  Note left of Partner: mutation Type 중 activateCounselors API 사용하여 상담사 비활성화
  Happytalk -->>- Partner: 상담사 활성화 처리 결과 반환

상담사 비활성화

sequenceDiagram
  participant Partner
  participant Happytalk
  Partner ->>+ Happytalk: 관리자 토큰 발급
  Note left of Partner: mutation Type 중<br/>newAuthTokenByAppCredential API 사용하여 발급
  Happytalk -->>- Partner: 관리자 Bearer 토큰 반환

  Partner ->>+ Happytalk: 상담사 비활성화 처리
  Note left of Partner: mutation Type 중 deactivateCounselors API 사용하여 상담사 비활성화
  Happytalk -->>- Partner: 상담사 비활성화 처리 결과 반환

  Partner ->>+ Happytalk: 허용 계정 수 변경 처리
  Note left of Partner: mutation Type 중 setAccountLimit API 사용하여 변경
  Happytalk -->>- Partner: 허용 계정 수 변경 처리 결과 반환