Menu
Beside each Titus Connect endpoint is a http method listed (‘Post‘, ‘Delete‘, ‘Get‘ & ‘Put‘).
HTTP methods define how clients interact with web servers and perform different actions on resources.
HTTP (Hypertext Transfer Protocol) is the foundation of communication on the World Wide Web. It is a protocol that defines how data is transmitted between a client and a server. HTTP methods are the actions that can be performed on a resource identified by a URL, including ‘Post‘, ‘Delete‘, ‘Get‘ & ‘Put‘.
GET is a HTTP method used for retrieving data. It is commonly used to fetch resource information from the server.
POST method is used to create new resources.
The PUT method is used to update or replace an existing resource on the server.
The DELETE method is an HTTP method used to remove or delete a resource from a server.
The API provides a new way to access and use data that is available within the LMS site. It will allow you to pass data to and from your LMS saving you hours of previously manual admin time.
Through standard API methods which can then be integrated by your team into other systems. The API provides one part of the data connection and the client provides the other part of the connection by accessing the data and connecting and configuring it with corresponding internal systems or APIs.
The API is like a DIY tool that comes with a guide on how to access its features. This guide is mainly designed for people who are comfortable with technical stuff, like working with APIs. So, you’ll need a good understanding of technical jargon and your internal systems to make it work. If you don’t have someone in your team with this know-how, you might need to get help from external experts.
This particular API works in a way that it provides information in a format called JSON. It’s helpful if you’re already familiar with terms like webservices, APIs, and JSON, as it will make using the API easier.
It’s important to know that the API doesn’t automatically put the data where you want it. To see the data in your own systems, your team has to use the API and the data format (JSON) to set it up in your chosen system(s).
The API is a generic tool that provides an output of data that can then be implemented into virtually any system.
This of course relies on the customer having the internal IT resource and system knowledge to integrate with the desired system.
The API Guide includes details of each endpoint relevant to the project and access to all other endpoints via Swaggerhub .
You may use all of these if you wish, or a selection of your choice.
The guide describes what data each endpoint provides, you should use any of the endpoints that provide the data you require.
The API provides flexibility as to the data you wish to access or make changes to. You may use all or only some of the endpoints, the choice is yours.
Please refer to the Swaggerhub which details the endpoints available.
There is currently no rate limiting in API v1.
Version 2, scheduled for Q1 2024, will implement rate limiting.
We use a Bearer Token to authenticate which is included in the header of the request.
Currently there is no ability for IP whitelisting. API v2 may look to implement this functionality.
A Moodle administrator is the only person who can generate new tokens.
The dataset that is available through the API is exactly the same dataset as can be accessed via the LMS site. Therefore the data you are able to view in the site is the data you can use via the API.
Access to this data is determined via roles, relationships and permissions within the site. Compliance with GDPR is a legal requirement which is achieved through architectural design of the product and appliation configuration (with the required user acceptance of site terms and conditions, data sharing agreements and contracts in place).