API 연동 플러그인 (External API)

챗봇이 단순히 대화만 하는 것을 넘어, 사내 시스템이나 외부 서비스의 데이터를 조회하고 제어할 수 있도록 도와주는 강력한 도구입니다.

1. 개요

API 연동 플러그인을 사용하면 챗봇 대화 도중 다음과 같은 작업을 수행할 수 있습니다:

"내 주문 배송 상태 조회해줘" → 사내 DB 조회 후 답변
"내일 오전 10시로 예약해줘" → 외부 캘린더 API 호출
"A/S 접수하고 싶어요" → 접수 시스템에 등록 후 접수번호 안내

2. 시작하기

플러그인 활성화

왼쪽 메뉴에서 [API 연동] 을 선택합니다.
상단의 API 연동 플러그인 토글을 켜서 활성화합니다.

방화벽 허용 IP 주소 (Outbound)

중요: 챗봇이 여러분의 API 서버에 접근하려면 방화벽 설정이 필요합니다.

API 연동 페이지 상단에 표시된 고정 IP 주소를 여러분의 서버 방화벽에 허용 목록으로 추가해야 합니다.

이 IP는 Cloudturing 시스템이 외부 API를 호출할 때 사용하는 고정 아웃바운드(Outbound) 주소입니다.

표시된 IP 주소를 개발팀 또는 보안팀에 전달하여 방화벽 허용 처리를 요청하세요.

3. 문서 업로드

API 명세서나 기술 문서를 업로드하면 AI가 자동으로 분석합니다.

지원 파일 형식

파일 형식	확장자	최대 크기	용도
PDF	.pdf	10MB	API 명세서, 기술 문서
텍스트	.txt, .md	10MB	Swagger, OpenAPI, API Key
이미지	.jpg, .jpeg, .png	5MB	다이어그램, 스펙 이미지

업로드 방법

[새 문서 업로드] 버튼을 클릭합니다.
API 명세서 파일을 선택합니다.
여러 파일을 한 번에 업로드할 수 있습니다.

팁: API Key가 있는 경우 TXT 형식으로 파일을 작성하여 업로드하세요.

4. AI 기능 정의

AI가 업로드된 문서를 분석하여 외부 시스템과 연동할 수 있는 기능을 자동으로 생성합니다.

프롬프트 작성 가이드

각 기능의 목적과 호출 조건을 **자연어(한국어)**로 명확하게 설명해주세요.

작성 형식 예시

# 기능 1: 실시간 배송 상태 조회
- 설명: 사용자가 주문 번호를 제공하면, 내부 배송 시스템 API를 호출하여 현재 배송 상태(결제완료, 배송중, 배송완료 등)를 조회하고 사용자에게 알려주는 기능입니다.
- 호출 조건: 사용자가 '배송 조회', '내 주문 어디있어?', '주문 상태 알려줘' 등 배송과 관련된 질문을 할 때 호출됩니다.

# 기능 2: A/S 접수 기능
- 설명: 제품 문제 발생 시, 사용자의 이름, 연락처, 제품 모델명, 문제 내용을 받아 A/S 접수를 생성하는 기능입니다. 접수 완료 후에는 사용자에게 접수 번호를 안내해야 합니다.
- 호출 조건: 사용자가 'A/S 신청', '고장 접수', '수리 맡기고 싶어' 등 수리나 A/S와 관련된 요청을 할 때 호출됩니다.

작성 팁

구체적으로: 설명이 구체적일수록 AI가 더 정확하게 동작합니다.
호출 조건 명시: 어떤 상황에서 API를 호출해야 하는지 명확히 작성하세요.
예시 포함: 사용자가 실제로 할 수 있는 질문 예시를 포함하세요.

5. AI로 코드 생성하기

AI 모델 선택

생성에 사용할 AI 모델을 선택할 수 있습니다. 모델에 따라 크레딧 소모량, 생성 시간, 결과물의 품질이 달라집니다.

[자세히 보기] 버튼을 클릭하면 각 모델별 특성을 확인할 수 있습니다.

코드 생성 실행

기능 정의 프롬프트를 작성합니다.
AI 모델을 선택합니다.
[AI로 코드 생성하기] 버튼을 클릭합니다.

진행 상태 확인

생성이 시작되면 진행 상태가 표시됩니다.

6. 결과 확인

기능 명세 탭

AI가 분석하여 생성한 기능 목록과 각 기능의 상세 명세를 확인할 수 있습니다.

소스 코드 탭

실제 작동하는 Node.js 코드를 확인할 수 있습니다.

작동 원리

사용자가 관련 질문을 합니다.
AI가 해당 질문이 API 연동이 필요한 상황인지 판단합니다.
필요한 경우 생성된 코드를 실행하여 외부 API를 호출합니다.
API 응답을 바탕으로 사용자에게 친절하게 답변합니다.

참고사항

이 기능은 클라우드 자원을 사용하는 고급 기능으로, 추가적인 크레딧이 소모될 수 있습니다.
API 보안이나 인증 관련 상세 설정이 필요한 경우 고객센터에 문의해 주세요.