API Documentation

This articles gives you a quick overview of our API. It explains the endpoints, use of our mock data and limitations.
Written by Joris Even
Updated 4 months ago

This API is a comprehensive tool for managing online learning environments, focusing on ease of course and tool integration, and efficient management of educational resources. It’s a critical resource for developers in the ed-tech space, providing the necessary technical details to build and maintain a seamless online learning experience.

Swagger

For more information and testing please take a look at the documentation here: Swagger API

API Overview

  • Purpose: The LtiSaas API is designed to facilitate the integration and management of online learning environments. It focuses on handling courses, Learning Tools Interoperability (LTI) tools, and learning objects.
  • Target Audience: This API is aimed at developers working in the education technology sector, particularly those involved in managing online courses and integrating various educational tools.

Versioning

  • Versions: The API has two primary versions - v0 and v1.
    • v0 is a test version that simulates API responses without actual database interaction. It's useful for development and testing purposes.
    • v1 is the production version, meant for live environments. It involves real data and actions.

Endpoints and Operations

You will find endpoints for use in the following categories.

Course Management

  • Create Course: Add new courses to the system.
  • Update Course: Modify details of existing courses.
  • List Courses: Retrieve a list of all courses, with filters and search capabilities.
  • Delete Course: Remove courses from the system.

LTI Tools Integration

  • Add LTI Tool: Integrate new LTI tools into the course environment.
  • Update LTI Tool: Change settings or details of existing LTI tools.
  • List LTI Tools: Fetch a list of all LTI tools associated with courses.
  • Delete LTI Tool: Remove LTI tools from courses.

Learning Objects Management

  • Manage Learning Objects: This includes adding, updating, and deleting learning objects like SCORM packages. (Currently limited to only SCORM-packages)

Data Formats and Protocols

  • JSON Format: The API communicates using JSON for both requests and responses. This includes sending data (like course details or LTI tool settings) and receiving data (like lists of courses or status messages).
  • HTTP Methods: It primarily uses GET and POST methods. GET is used for retrieving data, while POST is used for sending data to the server, including file uploads.

Authentication and Security

  • Access Tokens: The API uses access tokens for authentication. These tokens ensure that only authorized users can perform certain operations.
  • Security Practices: While the test version might use simpler authentication, the production version likely employs more robust security measures to protect sensitive data.

Response Handling and Limitations

  • Pagination and Limits: The API imposes a limit on the number of items returned in a single response, such as a maximum of 2500 results per request. This is to ensure performance and manageability.
  • Error Handling: It likely includes standard HTTP response codes to indicate success, errors, or issues with requests, helping developers understand and handle various scenarios effectively.

Use Cases and Practical Applications

  • Educational Institutions and Online Learning Platforms: Ideal for universities, online course providers, and educational technology companies.
  • Integration with Learning Management Systems: Can be used to enhance the capabilities of existing LMS platforms by adding or managing courses and tools.

Additional Features

  • Documentation and Support: The documentation might include examples of requests and responses, error codes, and troubleshooting tips. Support channels or forums may be available for developers seeking help.

Did this answer your question?