What is the Client API?

Modified on Tue, 13 Feb 2024 at 05:15 PM

Our client application programming interface (API) provides a means through which you can pull and push data to and from the iHasco Atlas Learning Management System (LMS) to other software applications.

For example, you can use it to synchronise users from a web based HR system with the iHasco Atlas LMS or routinely record details of completed training in your HR system.

Our API is language agnostic, this means regardless of the programming languages used by your software, you can connect to and use the API.

You can find full technical documentation on how to use the iHasco Client API at Client API Documentation.

To start using Client API you will need to enable API access and create an access token. See  How to enable/disable the client API for more information.

We provide two different APIs that are suitable for different use cases. You can access either API using the same access token.


REST API

The REST API provides maximum compatibility with different systems.

 

Use this API if:

 

  • You need to create, update or delete learners and their enrolments
  • You need a system with public documentation, available at https://api.ihasco.co.uk
  • You need to download minimal information about your learners and their training records
  • You do not need to filter the data you download from the API


GraphQL API

This API provides access to more data with enhanced filter controls. It also allows a large amount of related data to be accessed with a single network request.

 

Use this API if:

 

  • You are comfortable with a more technical integration
  • You only need to read data, not make inserts or updates
  • You need to access to all data about your learners, including assessments, enrolment data and course results
  • You need to filter data by a variety of metrics including date ranges and searches on custom fields

You can learn more on our Getting started with GraphQL page.

If you need further help or advice using the client API contact our support team at ihasco.co.uk/support.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article