使用Smrt English API連接您的系統

Smrt English API可讓學校的系統（例如學生資訊系統或報表儀表板）讀取您的學生和班級紀錄。API為唯讀：無法在Smrt English中新增、修改或刪除任何內容。

取得API金鑰

請聯絡Smrt English，為您的學校申請API金鑰。金鑰由Smrt English核發和管理。金鑰只會傳回您自己學校的學生和班級。

1. 學校取得金鑰後，開啟Dashboard，點選Home，再點選Settings。Client API區塊會顯示有效金鑰的數量，以及過去30天內的請求次數。

   

2. 將金鑰提供給負責建置整合的人員。他們需要在每個請求的X-API-Key標頭中傳送金鑰。

可以讀取的資料

• 學生：學生清單（可篩選和搜尋），或依使用者ID或電子郵件地址查詢單一學生，包括其班級、已完成的作業、評量和學習時間。
• 班級：班級清單，或單一班級及其老師和學生名單。
• 驗證：用於確認金鑰是否有效的測試。

完整的參考文件，包含PHP、Python和JavaScript範例，請參閱API文件。您的開發人員可以從該頁面連結的測試中心，在瀏覽器中試用每個端點。