본문 바로가기

API 문서

Smrt English Client API

학생과 클래스 기록을 기관의 시스템으로 제공하는 읽기 전용 API입니다. 각 API 키(API key)는 해당 기관의 데이터에만 접근할 수 있습니다.

테스트 허브 열기

작동 방식

요청 처리 방식

기관의 시스템이 자체 API 키로 학생이나 클래스 정보를 요청하면, API가 해당 기록을 읽기 전용으로 반환합니다.

기관 시스템기관의 학생 정보 시스템이나 리포트 도구입니다.
기관의 API 키모든 요청과 함께 전송되며, 해당 학교에 연결되어 있습니다.
Smrt English API학생과 클래스 정보를 위한 읽기 전용 엔드포인트입니다.
기관의 기록성적, 출결, 클래스 명단을 JSON으로 제공합니다.
keyboard_arrow_up

Smrt English API

vpn_key Authentication

All API requests require authentication using an API key passed in the HTTP header.

Header Format

X-API-Key: your_institution_api_key

Authentication Methods

The API supports the following header variations:

  • X-API-Key (recommended)
  • X-Api-Key
  • HTTP_X_API_KEY (server variable)

Security Notes

  • Keep your API key confidential and do not share it outside your institution
  • Never expose API keys in client-side code or public repositories
  • Use HTTPS for all API requests (enforced in production)
  • Your API key only provides access to your institution's student data