API hujjatlari

Smrt English Client API

Oʻquvchi va guruh maʼlumotlarini muassasangiz tizimlariga uzatadigan, faqat oʻqish uchun moʻljallangan API. Har bir API kaliti (API key) faqat oʻz muassasasining maʼlumotlariga kira oladi.

Test sahifasini ochish

Qanday ishlaydi

Soʻrov qanday ishlaydi

Tizimingiz oʻz API kaliti bilan oʻquvchi yoki guruh maʼlumotini soʻraydi, API esa maʼlumotlarni faqat oʻqish uchun qaytaradi.

Sizning tizimingizOʻquvchilar axborot tizimingiz yoki hisobot vositangiz.

API kalitingizHar bir soʻrov bilan yuboriladi va maktabingizga bogʻlangan.

Smrt English APIOʻquvchilar va guruhlar uchun faqat oʻqish uchun endpointlar.

Sizning maʼlumotlaringizBaholar, davomat va guruh roʻyxatlari JSON formatida.

keyboard_arrow_up

Smrt English API

play_arrow Getting Started

Step 1: Obtain Your API Key

Your institution's API key will be provided by your Smrt English representative. If you haven't received your API key yet, please contact your Smrt representative.

What you'll receive:

A unique API key string (e.g., your_institution_api_key)
Your institution ID (for reference)
API key name (for identification)

Step 2: Test Authentication

Once you have your API key, test it with the authentication endpoint:

curl -H "X-API-Key: your_institution_api_key" https://smrtenglish.com/smrtapi/v1/auth

Expected Response:

{
  "success": true,
  "data": {
    "authenticated": true,
    "school": {
      "id": 1,
      "name": "Your Institution Name",
      "key": "your_institution"
    },
    "api_key_name": "Your Institution Production API Key",
    "timestamp": "2025-09-29 22:20:32"
  },
  "message": "API key is valid and active"
}

Step 3: Try the Interactive Testing Hub

🚀 New: Interactive API Testing

Test all API endpoints in your browser without writing any code. Perfect for exploring the API and verifying your integration.

Launch Testing Hub →

Step 4: Retrieve Student Data

Option A: Get a List of Students

Retrieve a paginated list of all your students:

curl -H "X-API-Key: your_institution_api_key" \
  https://smrtenglish.com/smrtapi/v1/students

Option B: Get Individual Student Details

Retrieve comprehensive data for a specific student:

curl -H "X-API-Key: your_institution_api_key" \
  https://smrtenglish.com/smrtapi/v1/student/12345

Step 5: Integrate with Your Systems

Use the API to:

Export student rosters - Pull complete student lists for your SIS
Track progress - Monitor assignment completion and scores
Generate reports - Create custom analytics dashboards
Identify at-risk students - Find students who need intervention
Automate workflows - Sync data to your learning management system