For the complete documentation index, see llms.txt. This page is also available as Markdown.

고객 정보 연동

콘티플이 아닌 자체 사용 중인 외부 서비스의 정보를 API 설정을 통해 티켓 관리에서 조회할 수 있는 기능입니다.


➊ API 인증 방법

1-1. 암호화 키 (Security Key)

  • [고객정보관리] → [고객정보연동] → [API 설정]에서 API 암호화 여부를 예로 설정합니다.

  • 암호화 키가 자동 생성되며, 해당 키를 API 인증에 활용할 수 있습니다.


1-2. Authorization 문자열 생성 방법

다음2가지 방법으로 문자열을 생성할 수 있습니다.

① HmacSHA256로 암호화

② (request URI + 파라미터 값(json) + 현재 UTC시간 값)문자열에 대해 암호화

  • Java 예시


➋ 고객정보연동 API

(1) 인터페이스 설명

인터페이스 명
프로토콜
호출방향
인코딩
요청 파라미터 형식
URL
접근제한 여부

고객정보연동 API

HTTPS

POST

UTF-8

JSON

기본 URL

공통 인증


(2) 요청 파라미터 정의

명칭
변수
데이터 타입
필수
설명

설정한 조회 항목

callNum

String

O

nation

String


(3) Request Body


(4) 결과 데이터

명칭
변수
데이터 타입
필수
설명

설정한 결과 항목

userName

String

id

String


(5) Response Body


➌ 리턴 결과

(1) 파라미터 정의

명칭
변수
데이터 타입
필수
설명

성공 시 리턴 결과

data

JSON

O

OC에서의 결과 항목 설정값

String

O

명칭
변수
데이터 타입
필수
설명

실패 시 리턴 결과

error

JSON

O

code

String

O

message

String

O

detail

String

O


(2) HTTP 상태 코드

리턴 코드 정보
Online Contact 표시 메시지

200 : SUCCESS

조회 성공

400 : Bad Request

조회 결과가 없습니다.

403 : Forbidden

요청한 서버에 조회 권한이 없습니다.

404 : Not Data Found

요청한 서버에 에러가 있습니다.

500 : Server Error

오류가 발생하였습니다.


(3) 리턴 결과 예시

Last updated