eLearn Partner API Documentation

Base URL

https://api.masterteacher.net

Authentication

All API requests require OAuth2 authentication using the client credentials grant flow. Obtain a client ID and secret from your account administrator.

Token Endpoint: 
POST https://api.masterteacher.net/oauth/token
Request Body Example: 
{
  "grant_type": "client_credentials",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET"
}
Response Example: 
{
  "access_token": "...",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}
Authorization Header: 
Authorization: Bearer YOUR_ACCESS_TOKEN

Endpoints

List Assessments

GET /api/v1/ax/assessments

Returns a paginated list of assessments for the authorized tenant.

Request Example: 
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     https://api.masterteacher.net/api/v1/ax/assessments
Response Example: 
{
  "data": [
    {
      "seid": "user123",
      "name": "Jane Doe",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@example.com",
      "organization_id": 42,
      "organization_name": "Acme School District",
      "assessment_name": "Math Certification",
      "certified_on": "2024-05-01",
      "results": [
        {
          "assessment_id": 101,
          "assessment_name": "Math Certification",
          "certified_on": "2024-05-01",
          "proctor_id": 7,
          "proctor_name": "John Proctor"
        }
      ]
    }
  ],
  "meta": {
    "count": 1,
    "offset": 0,
    "page": 1
  }
}

Get Assessment

GET /api/v1/ax/assessments/:id

Returns a single assessment by ID.

Request Example: 
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     https://api.masterteacher.net/api/v1/ax/assessments/101
Response Example: 
{
  "seid": "user123",
  "name": "Jane Doe",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@example.com",
  "organization_id": 42,
  "organization_name": "Acme School District",
  "assessment_name": "Math Certification",
  "certified_on": "2024-05-01",
  "results": [
    {
      "assessment_id": 101,
      "assessment_name": "Math Certification",
      "certified_on": "2024-05-01",
      "proctor_id": 7,
      "proctor_name": "John Proctor"
    }
  ]
}

Data Model: Assessment

Field Type Description
seid string User State Educator ID
name string User full name
first_name string User first name
last_name string User last name
email string User email address
organization_id integer Organization (tenant) ID
organization_name string Organization (tenant) name
assessment_name string Name of the assessment
certified_on string Date of certification (YYYY-MM-DD)
results array List of assessment result objects
Result Object:
Field Type Description
assessment_id integer Assessment ID
assessment_name string Assessment name
certified_on string Date certified (YYYY-MM-DD)
proctor_id integer Proctor user ID
proctor_name string Proctor name

Error Handling

All errors will be returned with appropriate HTTP status codes and a JSON body describing the error.

Example Error Response: 
{
  "error": "invalid_token",
  "error_description": "The access token is invalid"
}

Contact

For access or support, please contact your account administrator or support@masterteacher.com.