Smrt English API로 기관 시스템 연결

Smrt English API를 사용하면 학생 정보 시스템이나 리포트 대시보드 같은 학교의 시스템에서 학생 및 클래스 기록을 읽을 수 있습니다. API는 읽기 전용이므로 Smrt English의 데이터를 추가, 변경, 삭제할 수 없습니다.

API 키 발급

학교의 API 키(API key)를 요청하려면 Smrt English에 문의하시기 바랍니다. API 키는 Smrt English가 발급하고 관리합니다. 키로는 해당 학교의 학생과 클래스만 조회할 수 있습니다.

1. 학교에 키가 발급되면 Dashboard(대시보드)를 열고 Home을 클릭한 다음 Settings를 클릭합니다. Client API 상자에 활성 키 수와 최근 30일간의 요청 수가 표시됩니다.

   

2. 연동을 개발하는 담당자에게 키를 전달합니다. 담당자는 모든 요청의 X-API-Key 헤더에 키를 담아 보냅니다.

조회할 수 있는 정보

• Students: 필터와 검색을 지원하는 학생 목록, 또는 사용자 ID나 이메일 주소로 조회한 학생 한 명의 정보(클래스, 완료한 과제, 평가, 학습 시간 포함)
• Classes: 클래스 목록, 또는 담당 교사와 학생 명단을 포함한 클래스 하나의 정보
• Auth: 키가 작동하는지 확인하는 테스트

PHP, Python, JavaScript 예제를 포함한 전체 레퍼런스는 API 문서에 있습니다. 개발자는 문서에 링크된 테스트 페이지에서 브라우저로 모든 엔드포인트를 시험해 볼 수 있습니다.