앨리클래스 Open API 연동 지원 사이트
웹사이트나 HTML기반 컨텐츠에서, 자유롭게 앨리을 생성하고 API 호출을 통하여 실행을 할 수 있도록 지원하기 위한 사이트입니다. 본 API를 사용하면 [이용약관]에 동의하는 것으로 간주합니다. 본사와 협의에 의하여 서비스 제휴사가 되면 [제휴사 이용약관]에 준하여 추가적인 API를 제공 받을 수 있습니다. 모든 문의사항은 
으로 접수하기 바랍니다.
으로 접수하기 바랍니다.앨리 생성
API로 실행할 앨리을 생성하기 위한 편집기입니다. 여기에서 편집된 결과를 JSON으로 복사하고 API를 호출하여 실행할 수 있습니다.
유형 및 예제는 다음과 같습니다.
앨리 실행
(1) 앨리을 사이트에 붙이기 위해서는 다음과 같이 앨리 API 소스를 HTML에 추가합니다.
<script type="text/javascript" src="https://allyclass.io/share/api.js"></script>
(2) 예를 들면, 다음과 같이 ally.run() API를 호출합니다. 첫번째 인수가 편집된 앨리 데이터입니다. 두번째 인수는 HTML에서 앨리을 실행한 HTML Tag입니다.
<div onclick="ally.run(['choice','T','다음 내용을 읽고 \'O\' 또는 \'X\'를 선택하세요.다람쥐가 도토리 23개를 4명의 친구에게 5개씩 똑같이 나누어 주었더니 창고에 2개가 남았습니다.',2,'O','X',1,1],this)">실행</div>
(3) 시험 및 검증 절차
①Tag를 클릭하여 앨리이 새 브라우저 창에서 실행되는 것을 확인합니다.
②QR코드로 접속하여 제출하고, 그 결과가 [제출내역]에 표시되는 것을 확인합니다.
③앨리 창을 닫고, ①항의 절차를 반복합니다. 다시 실행된 브라우저 창의 [제출내역]이 그대로 유지되고 있는 것을 확인합니다.
앨리허브 실행
앨리허브는 교사가 수업 중에 필요한 라이브 을 바로 실행할 수 있도록 지원하기 위한 모듈입니다. 다음과 같은 기능을 제공합니다.
앨리허브는 <IFRAME> Tag에서 실행될 수 있으므로, ally.hub.run()을 호출하여 웹사이트에서 지정한 Tag에 실행시킬 수 있습니다. '과목'과 '학년'은 앨리허브에 연결된 앨리을 검색하기 위한 조건으로 호출하는 웹사이트가 이에 해당하지 않으면 값을 지정하지 않아도 됩니다.
①수업용 앨리생성기
②수업용 앨리 갤러리
③앨리 실행 기록
과목 학년
앨리 API 규격
위의 문서 및 코드에서 사용된 API의 규격은 다음과 같습니다.
ally.run(/*Array*/data, /*Tag*/tag, /*Object|undefined*/options)
'data'에 해당하는 앨리을 실행하고 그 실행 Context를 'tag'에 저장한다.
| 패러미터 | 값 | 필수 |
|---|---|---|
| data | [앨리생성기]에서 편집한 Array형 데이터 | O |
| tag | 을 실행한 Tag. 이 Tag에 앨리의 재실행 Context가 저장되므로 실행된 앨리 창을 닫아도 이 Tag가 다시 전달되면 의 제출 결과가 그대로 유지되어 실행되는 것이 보장된다. | O |
| options |
onResult:Function {onResult:function(/*{message:String}|undefined*/){...}}와 같이 호출하면 이 API의 실행 결과를 받을 수 있다. Callback 함수의 인수가 {message:String} 형태로 전달되면 개발 오류 등으로 실패한 것이다.
saveHistory:Booleantrue로 지정하면 실행된 앨리을 사용자의 HTML5 Local Storage에 저장한다. 이것은 앨리허브의 '최근 앨리'에 표시된다. Local Storage에 저장하므로 공용 PC에서는 사용에 주의해야 한다.
|
ally.ping(/*Function*/onResult, /*String|undefined*/keyEnterprise)
본 서비스가 현재 정상 제공 중인지 확인한다. 서비스가 중지된 상태이면 UI적으로 실행 버튼을 미리 감출 수 있도록 하기 위한 등의 목적이다.
| 패러미터 | 값 | 필수 |
|---|---|---|
| onResult | function(/*Boolean*/){...} 형태이며, Callback 인수가 true가 아니면 서비스가 중지된 것이다. | O |
| keyEnterprise | 전용 앨리 서버를 소유하고 있는 경우, 서버 등록 번호. 그냥 Open API로 호출하는 경우에는 이 값을 사용하지 않는다. |
ally.hub.run(/*Tag*/iframe, /*Object|undefined*/meta)
'iframe'에 해당하는 IFRAME Tag에 앨리허브를 로딩한다. 이때 'meta'가 존재하면 '앨리 갤러리'의 메타 정보로 적용된다. ally.run()에서 saveHistory를 true로 호출한 경우에는 실행된 활동 이력이 이 화면에 표시되며, 만약 IFRAME Tag가 이미 표시 중이라면 이력이 자동으로 반영된다.
| 패러미터 | 값 | 필수 |
|---|---|---|
| iframe | 앨리허브를 로딩할 IFRAME Tag | O |
| meta | 이 API를 호출하는 웹사이트 또는 컨텐츠의 메타 정보. {subject:String, grade:String}의 형태이며 각 항목의 값은 본 문서의 [앨리허브]에 있는 [코드보기] 버튼을 통하여 확인할 수 있다. |
앨리 오류 메시지
API의 실행과 관련하여, 앨리에서 표시하는 오류 메시지는 다음과 같습니다.
위의 오류는 실행에 필요한 이미지를 로딩할 수 없는 경우에 표시됩니다. 이것은 이미지 URL 자체의 편집 오류이거나 일시적으로 해당 이미지에 접속되지 않은 경우일 수도 있습니다. 또는, 해당 이미지 사이트에서 CORS 등의 이슈로 접근을 막은 상황에도 해당될 수 있습니다.