연동 가이드 — 데모로 보는 API 구현

아래 데모 사이트는 여러분의 서비스와 똑같은 입장에서 자람 공개 API만으로 만들어졌습니다. 화면은 업체가 자유롭게 구성하고, 인코딩·자막·문제·질의응답 같은 처리는 자람 API가 담당합니다. 각 기능이 어떤 API로 구현되는지, 데모 화면과 함께 보여 드립니다.

연동 구조 — 화면은 여러분, 처리는 자람

계약한 기능만 보이기

이 키가 어떤 상품을 계약했는지 돌려줍니다. 데모는 이 값으로 계약 안 한 메뉴를 미리 숨깁니다.

curl -H "X-API-Key: 키" \
  https://api.jaramai.co.kr/api/v1/me

콘텐츠 분류 (대·중·소 3단)

영상·콘텐츠를 담는 대·중·소 3단 분류 트리를 가져오거나 만듭니다. 업종에 맞게 자유롭게 구성하면 됩니다 — 데모는 학원이라 «과목 › 교수 › 세부»로 썼지만, 예컨대 «브랜드 › 시즌 › 캠페인», «부서 › 과정 › 차시»처럼 쓸 수 있습니다.

GET  /api/v1/categories   # 트리 조회
POST /api/v1/categories   # 분류 추가

영상 등록 · 인코딩

영상은 서버(지정 경로)에 원본을 먼저 올린 뒤 그 경로를 입력해 등록합니다 — 대용량을 브라우저로 통째 올리지 않습니다. 등록(/videos) 후 인코딩 작업을 맡기면(/jobs type=encode) 완료 시 웹훅 알림이 오고, 결과물은 output으로 받습니다.

POST /api/v1/videos              # 원본 등록
POST /api/v1/jobs {type:encode}  # 인코딩 시작
# 완료 → Webhook
GET  /api/v1/jobs/{id}/output/{file}

자막 · 교정 · 요약

영상에서 자막을 뽑고 용어집으로 교정하고 요약까지 만듭니다. 자막은 srt·vtt로도 받아 플레이어에 바로 물립니다.

POST /api/v1/jobs {type:transcribe}
# 완료 → 자막(vtt/srt) · 요약 수신

‹

›

문제은행

자막을 근거로 문항을 자동 출제합니다. 운영자가 검수(승인/반려)한 문항만 학생에게 나갑니다.

POST /api/v1/jobs {type:quizgen}
# 완료 → 문항 → 검수 → 학생 노출

‹

›

챗봇 근거 자료 등록

콘텐츠 자료(PDF·문서)를 올리면 벡터DB에 적재되어 이후 질의응답의 근거 문서로 쓰입니다.

POST /api/v1/documents

학습 질의응답 · AI 챗봇

학생 질문에 자막·자료를 근거로 AI가 답합니다(/ask). 질문은 게시판에도 기록됩니다(/board). 근거가 없으면 운영자 상담으로 자동 전환합니다.

POST /api/v1/ask     # 질의응답(AI)
POST /api/v1/board   # 학습 Q&A 기록

‹

›

도입하기