CLUB STUDY

CLUB STUDY 개발자 안내

어떤 정보를 조회할 수 있나요?

CLUB STUDY Public Agent API는 클럽스터디 개인 학습관리와 Campus의 공식 제품 이름, 대상과 안내 페이지를 반환하는 읽기 전용 API입니다. 공개 정보 조회에 인증키나 회원가입은 필요하지 않습니다. 개인 학습 기록, 학생 명부, 결제나 신청을 처리하는 외부 API는 제공하지 않습니다.

사이트 정보 조회

GET https://weareclubstudy.com/api/agent/site

응답은 application/json이며 name, alternateName, description, url, locale, products, resources 필드를 포함합니다. products의 bestFor는 제품이 맞는 사용 상황을 설명합니다.

Markdown으로 본문 읽기

공개 콘텐츠 페이지에 Accept: text/markdown 헤더를 보내면 해당 HTML의 실제 본문을 Markdown으로 반환합니다. Accept의 q 값에 따라 HTML과 Markdown을 선택합니다. 두 형식 모두 거부하면 406을 반환합니다. 응답의 Vary: Accept는 캐시가 두 형식을 구분하게 합니다. API와 로그인·신청·결제 페이지는 이 변환 대상에 포함하지 않습니다.

오류는 어떻게 처리하나요?

존재하지 않는 API 경로는 404와 JSON error 객체를 반환합니다. 객체의 code는 NOT_FOUND, message는 오류 설명, resolution은 OpenAPI 확인 안내입니다. 사이트 정보 API에 GET·HEAD·OPTIONS 외의 메서드를 사용하면 405와 METHOD_NOT_ALLOWED를 반환합니다. HTML 페이지가 없다면 Markdown 변형도 404를 유지하며 사이트맵과 복구 링크를 제공합니다. 본문 변환 중 원본 사이트에 연결할 수 없으면 503을 반환하므로 잠시 후 재시도해 주세요.

사용 범위와 문의

공개 메타데이터 API는 인증 없이 읽을 수 있지만 별도 SLA나 전용 쿼터를 약속하지 않습니다. 변경되지 않는 사이트 정보는 재사용하고, 오류가 반복되면 간격을 늘려 재시도해 주세요. 사용자 개인정보와 인증 정보를 전송하지 마세요. 제품 연동이나 쓰기 API가 필요하다면 공식 문의에서 요구사항을 알려 주세요.