Ally Class Open API 연동 지원 사이트
웹사이트 또는 HTML 기반 콘텐츠에 라이브 퀴즈, 설문 등 다양한 실시간 참여 활동을 손쉽게 추가하고 실행할 수 있도록 지원하는 Ally Open API의 개발자 지원 사이트입니다.
본 API를 사용하는 경우, [이용약관]에 동의한 것으로 간주합니다. 본사와의 협의를 통해 서비스 제휴사로 등록될 경우, [제휴사 이용약관]에 따라 추가 API를 제공받을 수 있습니다. 모든 문의사항은 [사용자지원센터]로 접수해 주시기 바랍니다.

활동 데이터 생성
API로 실행할 Ally 활동을 생성하기 위한 편집기입니다. 여기에서 편집한 결과를 JSON 형식 또는 URL로 복사하여 실행할 수 있습니다.
생성기의 [] 항목에서는 <latex>⋯</latex> 태그를 사용하여 LaTeX 수식을 추가할 수 있으며, <u>⋯</u> 태그를 사용하여 밑줄을 표시할 수 있습니다.

Ally 생성기

데이터편집

활동 유형과 각 유형별 예제는 다음과 같습니다.


활동 추가
■ HTML과 JavaScript를 활용한 구현 방식
JavaScript API를 호출하여 HTML 태그에 활동 실행 기능을 추가하는 절차는 다음과 같습니다.
(1) Ally 활동을 웹사이트에 추가하려면, 다음과 같이 앨리 API 소스를 HTML에 추가합니다.
<script type="text/javascript" src="/share/api.js"></script>
(2) 예를 들어, 다음과 같이 ally.run() API를 호출합니다. 첫 번째 인수는 편집된 Ally 활동 데이터이며, 두 번째 인수는 HTML에서 Ally 활동을 실행할 대상 HTML 태그입니다.
<div onclick="ally.run(['ox','T','다람쥐가 도토리 23개를 4명의 친구에게 5개씩 똑같이 나누어 주었더니 창고에 2개가 남았습니다.',2,'◯','╳',1,2],this)">실행</div>
■ HTML <a> 태그를 활용한 구현 방식
[] 버튼을 통해 생성된 URL에 직접 연결하면 Ally 활동을 실행할 수 있습니다. 따라서, 다음과 같이 <a> 태그를 사용하여 활동을 추가할 수 있습니다.
예를 들어, 다음과 같이 <a> 태그를 HTML에 추가합니다.
<a target="activity" href="https://allyclass.com/pan/1/?aid=5dd83383-c218-4919-b1c6-be7cab5b0f4d&ally=%5B%22ox%22%2C%22T%22%2C%22%EB%8B%A4%EB%9E%8C%EC%A5%90%EA%B0%80%20%EB%8F%84%ED%86%A0%EB%A6%AC%2023%EA%B0%9C%EB%A5%BC%204%EB%AA%85%EC%9D%98%20%EC%B9%9C%EA%B5%AC%EC%97%90%EA%B2%8C%205%EA%B0%9C%EC%94%A9%20%EB%98%91%EA%B0%99%EC%9D%B4%20%EB%82%98%EB%88%84%EC%96%B4%20%EC%A3%BC%EC%97%88%EB%8D%94%EB%8B%88%20%EC%B0%BD%EA%B3%A0%EC%97%90%202%EA%B0%9C%EA%B0%80%20%EB%82%A8%EC%95%98%EC%8A%B5%EB%8B%88%EB%8B%A4.%5Cn%22%2C2%2C%22%E2%97%AF%22%2C%22%E2%95%B3%22%2C1%2C2%5D">Ally 활동 실행</a>

시험 및 검증
■ 시험 및 검증 절차
①해당 HTML 태그를 클릭하여 Ally Class의 클래스 대시보드가 새 브라우저 창에서 실행되는지 확인합니다.
②QR 코드로 접속하여 제출을 완료한 뒤, 해당 결과가 클래스 대시보드의 [제출내역]에 표시되는지 확인합니다.
③클래스 대시보드 창을 닫은 후, ①의 절차를 다시 수행합니다. 다시 실행된 브라우저 창에서 [제출내역]이 그대로 유지되는지 확인합니다.
■ Ally Class 오류 메시지
활동 실행과 관련하여 Ally Class에서 화면에 표시되는 오류 메시지는 다음과 같습니다.
위 오류는 활동의 실행에 필요한 이미지를 로드할 수 없는 경우에 표시됩니다. 이는 이미지 URL 자체의 편집 오류이거나, 일시적으로 해당 이미지에 접근할 수 없는 경우일 수 있습니다. 또한 이미지 제공 사이트에서 CORS 등의 이슈로 접근이 차단된 경우에도 발생할 수 있습니다.

Open API 규격
위 문서와 예제 코드에서 사용된 API의 상세 규격은 다음과 같습니다.
ally.run(/*Array*/data, /*Tag*/tag, /*Object|undefined*/options)
'data'에 해당하는 Ally 활동을 실행하고, 해당 실행 컨텍스트를 'tag'에 저장합니다.
파라미터설명필수
data[Ally 생성기]에서 편집한 Array형 데이터입니다.O
tag활동을 실행한 HTML 태그입니다. 이 태그에 Ally의 재실행 컨텍스트가 저장되므로, 실행된 Ally 창을 닫더라도 해당 태그가 다시 전달되면 활동의 제출 결과가 그대로 유지된 상태로 재실행됨이 보장됩니다.O
options onResult
{onResult:function({message:String}|undefined){...}}와 같이 호출하면 이 API의 실행 결과를 받을 수 있습니다. 콜백 함수의 인수가 {message:String} 형태로 전달되는 경우, 개발 오류 등으로 인해 실행에 실패한 상태를 의미합니다.
X
ally.ping(/*Function*/onResult, /*String|undefined*/keyEnterprise)
본 서비스가 현재 정상적으로 제공 중인지 여부를 확인합니다. 서비스가 중지된 상태인 경우, UI에서 실행 버튼을 사전에 숨기기 위한 용도로 사용할 수 있습니다.
파라미터설명필수
onResultfunction(/*Boolean*/bService){...} 형태이며, 콜백 인수가 true가 아닌 경우 서비스가 중지된 상태임을 의미합니다.O

Open API
홈지원센터이용약관제휴사 이용약관
© 2024 Bluega Inc. All rights reserved.
Ally Class Open API 이용 약관
본 약관은 블루가㈜(이하 "회사")가 제공하는 Ally Class Open API(이하 "API")의 사용 조건과 사용자 의무 및 회사의 책임 한계를 규정하는 문서입니다.
제1조 (API 제공 목적 및 정의)
1.본 API는 웹사이트나 HTML 기반 콘텐츠에서 Ally Class의 활동을 실행하거나 콘텐츠 허브를 표시할 수 있도록 하기 위한 목적으로 제공됩니다.
2."사용자"란 본 API를 연동하거나 호출하여 서비스를 구성하는 개인, 단체 또는 기업을 의미합니다.
제2조 (이용 조건)
1.본 API는 누구나 사전 허가나 비용 지불 없이 자유롭게 사용할 수 있는 무료 서비스입니다.
2.본 API 호출 또는 URL 연결을 통해 Ally Class의 활동을 실행할 수 있으며, 실행된 활동은 다음과 같은 조건의 무료 사용 정책이 적용됩니다.
•클래스룸 참여 가능 인원: 최대 50명
•결과 저장 가능 활동 수: 최대 3개
•이미지 등 자원에 Data URI를 사용할 수 없음
3.본 API는 서비스 구조 변경, 보안 강화, 내부 정책 등에 따라 사전 고지 없이 변경되거나 중단될 수 있습니다.
4.사용자가 본 API를 사용하는 것은 본 약관의 내용에 동의한 것으로 간주합니다.
제3조 (책임의 제한)
1.회사는 본 API의 지속적인 제공, 유지/보수 및 기술 지원에 대한 어떠한 보장도 하지 않습니다.
2.본 API 사용에 따른 직접적 또는 간접적 손해(예: 데이터 손실, 사용자 불만, 매출 손해 등)에 대해 회사는 어떠한 법적 책임도 지지 않습니다.
3.사용자는 본 API를 사용할 때 발생하는 모든 결과에 대한 책임을 스스로 부담합니다.
제4조 (사용 제한 및 금지 행위)
1.사용자는 본 API를 다음의 목적이나 방식으로 사용해서는 안 됩니다.
•불법적이거나 부정한 목적의 사용
•저작권, 초상권 등 제3자의 권리를 침해하는 콘텐츠 실행
•본 서비스의 안정성을 위협하거나 부하를 유발하는 방식으로 과도한 호출
2.위 사항을 위반할 경우, 회사는 본 API 호출 차단 또는 법적 조치를 취할 수 있습니다.
제5조 (약관의 변경)
1.본 약관은 예고 없이 변경될 수 있으며, 변경 사항은 본 사이트 또는 별도 안내를 통해 공지됩니다.
2.변경된 약관은 공지 시점부터 즉시 효력을 갖습니다.
제6조 (준거법 및 분쟁 해결)
1.본 약관에 관한 분쟁은 대한민국 법률을 기준으로 해석하며, 관할 법원은 서울중앙지방법원으로 합니다.
[부칙]
본 약관은 2025년 7월 31일에 게시되었으며, 동일한 날부터 시행됩니다.
Ally Class Open API 제휴사 이용 약관
본 약관은 블루가㈜(이하 "회사")와 공식 제휴를 체결한 제휴사(이하 "제휴사")가 Ally Class Open API(이하 "API")를 이용하는 데 있어 준수해야 할 조건, 권리 및 의무를 규정합니다.
제1조 (약관의 적용)
1.본 약관은 Ally Class Open API 이용 약관(이하 "기본 약관")을 기본으로 하며, 제휴사에게 추가적으로 적용됩니다.
2.본 약관과 기본 약관의 내용이 상충하는 경우, 개별 제휴 계약서 또는 본 약관의 내용이 우선 적용됩니다.
제2조 (제휴사의 정의 및 승인 절차)
1."제휴사"란 회사와 사전 협의를 거쳐 공식적으로 승인된 기관, 기업 또는 단체를 의미합니다.
2.회사는 제휴 승인 여부 및 지원 범위에 대해 최종적인 판단 권한을 가집니다.
제3조 (추가 서비스 제공)
1.제휴사에게는 협의 또는 계약에 따라 아래와 같은 추가 기능 또는 기술 지원이 제공될 수 있습니다.
•추가적인 유형의 앨리 생성 기능
•기타 제휴 목적에 부합하는 추가적인 API 또는 서비스
2.제공 범위 및 조건은 개별 협의 또는 계약서를 통해 구체적으로 정합니다.
제4조 (의무 및 책임)
1.제휴사는 본 약관 및 기본 약관의 모든 조항을 성실히 이행해야 하며, 부정 사용이 확인될 경우 회사는 API 호출을 차단하거나 이용을 제한할 수 있습니다.
제5조 (기타 조항)
1.제휴와 관련된 상세 조건, 기술 지원 범위, 운영 방식 등은 별도의 계약서 또는 협약서를 통해 정할 수 있습니다.
2.본 약관은 회사의 판단에 따라 예고 없이 변경될 수 있으며, 변경 시 본 사이트 또는 제휴사에게 개별 연락을 통해 고지됩니다.
제6조 (계약의 해지 및 종료)
1.제휴사는 회사와의 협의 또는 계약에 따라 제휴를 해지할 수 있으며, 해지 즉시 관련 API 사용 권한은 종료됩니다.
2.회사는 제휴사가 본 약관 또는 개별 계약 조건을 위반한 경우, 제휴를 해지하거나 관련 서비스 제공을 중단할 수 있습니다.
[부칙]
본 약관은 2025년 7월 3일에 제정되었으며, 해당 제휴사와의 계약 체결일로부터 적용됩니다.
URL을 통한 실행 방식 주의사항
URL을 사용하여 Ally 활동을 실행하려는 경우, 실행 단계 및 사용 환경에 따라 URL 길이에 대한 제약이 있을 수 있으므로 Ally 데이터를 작게 유지할 수 있는 상황에서 사용하기 바랍니다.
따라서 다음 주의사항을 반드시 확인하기 바랍니다.
■ Ally 서비스 시스템
•Ally 시스템은 최대 8kB 정도의 URL을 지원합니다.(2025년 7월 기준)
■ 웹 브라우저
•통상적으로 상용 브라우저는 일반적인 웹서버보다 긴 URL을 지원하도록 설정되어 있지만 그래도 잘 실행되는지 확인하기 바랍니다.
■ 사용자 서비스 시스템
•사용자의 서비스 시스템 또는 연관된 외부 시스템에서 표시, 등록 및 공유 가능한 URL의 최대 길이를 확인하기 바랍니다.