Happytalk Embedded

Introduce

본 서비스는 해피톡 상담하기 기능을 해피톡 서비스에서 동작하는 것이 아닌 다른 서비스 내에 삽입하여 사용할 수 있게 만든 서비스입니다.

API HOST

Division	HOST URL
개발	https://patch-gql-gw.happytalk.io/graphql
운영	https://gql-gw.happytalk.io/graphql

Credential Description

해피톡 임베디드에는 인증을 위한 두 가지 종류의 Credential(Key&Secret Pair)가 있습니다.

1. Partner Credential

회사간 제휴(파트너쉽)를 통해 수동으로 발급해드립니다. 고객센터로 문의해주세요.
파트너 권한으로 사용 가능한 API의 인증 절차에서 사용됩니다.

2. App Credential

App 권한으로 사용 가능한 API의 인증 절차에서 사용됩니다.
(API에 따라 Parter와 App 두 권한이 모두 필요한 경우도 있습니다.)
Partner Credential을 활용하여 서비스 흐름도 > 1.고객사 가입절차를 진행하면,
addSiteByMbiPartner mustation의 반환값 중 하나로 App Credential을 획득할 수 있습니다.

자세한 Credential 사용 방법은 인증키 사용 방법 샘플을 참고해주세요.

Happytalk Web Page Info

1. Authorization URL

해피톡 상담 페이지 접근시 Authorization URL(서비스 흐름도 > 3.해피톡 페이지 연결)으로만 접근이 가능합니다.
Ex) https://{HOST URL}/sso/app?code=${authorizationCode}&redirectTo=${redirectURL}
https:///happytalk.io/sso/app?code=${authorizationCode}&redirectTo=${redirectURL}
(redirectURL을 전달하지 않을 경우, 사용자 권한에 맞는 기본 페이지로 이동합니다.)

Division HOST URL

개발 https://patch.happytalk.io/sso/app

운영 https://happytalk.io/sso/app

2. Redirect URL

Redirect URL HOST

Division HOST URL

개발 https://patch-counselor.happytalk.io

운영 https://counselor.happytalk.io
Counsel Pages

Types Web Page Path

채팅 화면 https://{HOST URL}/custom/chatting/${roomId}

상담이력 상세보기 https://{HOST URL}/custom/chat/history/${roomId}

API List

Reference

GraphQL 공식 문서

Change History

History

2023

2023.07.07

1. OPEN API
   - Embedded Happytalk 문서 최초 작성

2023.07.13

1. OPEN API
   - Embedded Happytalk 문서 내용 오류 수정
     - x-mbi-partner-signature, x-mbi-app-signature 관련 설명
   - Embedded Happytalk 문서 명청 변경
     - Embedded Happytalk에서 Happytalk Embedded로 변경

2023.07.28

1. OPEN API
   - Embedded Happytalk 문서 내용 추가
     - 기본정보 페이지내 Happytalk Web Page Info 추가
     - 서비스 흐름도내 신규 상담사 추가시 유의 사항 내용 추가
     - 서비스 흐름도내 상담사 활성화 흐름도 추가
     - 테스트 HOST URL 변경

2023.11.02

1. OPEN API
   - Embedded Happytalk 문서 내용 추가
     - GQL PlayGround 상담사 추가 API 필드 추가 
       - 상담방 전체 검색 기능 사용 여부 내용 추가

2024

2024.01.31

1. OPEN API
   - Happytalk Embedded 문서 수정
    - 웹훅 수신 데이터 정보 중 "고객 UID" Data Type 수정

Division	HOST URL
개발	https://patch.happytalk.io/sso/app
운영	https://happytalk.io/sso/app

Division	HOST URL
개발	https://patch-counselor.happytalk.io
운영	https://counselor.happytalk.io

Types	Web Page Path
채팅 화면	https://{HOST URL}/custom/chatting/${roomId}
상담이력 상세보기	https://{HOST URL}/custom/chat/history/${roomId}