콘텐츠로 이동

SMSBAT ChatHub API

ChatHub REST API는 Viber 비즈니스 채팅, 고객 대화 및 고객 지원 자동화 워크플로를 관리합니다.

기본 URL

https://chatapi.smsbat.com

스웨거 문서

대화형 API 문서는 다음 위치에서 확인할 수 있습니다.

https://chatapi.smsbat.com/index.html

인증

ChatHub는 JWT 토큰과 함께 Bearer 토큰 기반 인증 시스템을 사용합니다. 토큰은 두 가지 방법으로 전달될 수 있습니다.

방법 1: 인증 헤더

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "Authorization: Bearer your-jwt-token"

방법 2: X-Authorization-Key 헤더

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "X-Authorization-Key: your-jwt-token"

인증 흐름

ChatHub는 두 가지 수준의 토큰 시스템을 사용합니다.

  1. 회사 토큰 - 조직 수준 액세스 토큰
  2. 운영자 토큰 - 개별 운영자 액세스 토큰

작업 흐름

graph LR
    A[Get Company Token] --> B[List Organizations]
    B --> C[List/Add Operators]
    C --> D[Get Operator Token]
    D --> E[Integrate Widget]

주요 엔드포인트

방법 엔드포인트 설명
포스트 /api/회사/get-token 회사 인증 토큰 획득
받기 /api/회사/조직 조직 목록 검색
받기 /api/연산자 조직별 운영자 나열
포스트 /api/연산자/동기화 새 연산자 추가
포스트 /api/연산자/상태 운영자 상태 변경
포스트 /api/operator/get-token 운영자 토큰 생성(최대 24시간 만료)
포스트 /api/operator/validate-token 토큰 유효성 확인

주요 기능

회사 토큰 관리

API 액세스를 위한 조직 수준 토큰을 획득하고 관리하세요.

조직 관리

  • 모든 조직 나열
  • 조직 세부 정보 검색
  • 조직 설정 관리

운영자 관리

  • 조직별 운영자 목록
  • 새로운 연산자 추가
  • 운영자 상태 변경(활성/비활성/삭제)
  • 사업자별 토큰 생성(최대 24시간)
  • 운영자 토큰 검증

위젯 통합

실시간 고객 지원을 위해 ChatHub 위젯을 웹 애플리케이션에 통합하세요.

빠른 시작

  1. 인증 - 회사 및 운영자 토큰 받기
  2. 조직 - 조직 관리
  3. 운영자 - 운영자 추가 및 관리
  4. 위젯 통합 - 채팅 위젯 통합

요청 형식

모든 요청은 JSON 형식을 사용합니다.

{
  "login": "your-login",
  "password": "your-password"
}

응답 형식

성공적인 응답은 다음을 반환합니다.

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiration": "2025-01-24T12:00:00Z"
}

오류 처리

HTTP 상태 코드:

  • 200 OK - 요청 성공
  • 400 잘못된 요청 - 잘못된 요청 형식
  • 401 Unauthorized - 인증 실패
  • 403 금지됨 - 권한 부족
  • 404 찾을 수 없음 - 리소스를 찾을 수 없음
  • 500 내부 서버 오류 - 서버 오류

토큰 만료

토큰에는 만료 시간이 있습니다. 토큰이 만료되는 경우:

  1. API는 '401 Unauthorized'를 반환합니다.
  2. 인증 엔드포인트를 사용하여 새 토큰을 요청합니다.
  3. 새 토큰으로 애플리케이션을 업데이트하세요.

다음 단계