Documentation de l’API

API client Smrt English

Une API en lecture seule qui transmet les dossiers des élèves et des classes aux systèmes de votre établissement. Chaque clé d’API (API key) n’a accès qu’aux données de son propre établissement.

Ouvrir l’espace de test

Fonctionnement

Le déroulement d’une requête.

Votre système demande un apprenant ou une classe avec sa propre clé d’API, et l’API renvoie les dossiers en lecture seule.

Votre systèmeVotre système de gestion des dossiers étudiants ou votre outil de rapports.

Votre clé d’APIEnvoyée avec chaque requête et rattachée à votre établissement.

API Smrt EnglishDes points de terminaison (endpoints) en lecture seule pour les apprenants et les classes.

Vos dossiersNotes, présences et listes de classe au format JSON.

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