Skip to main content

What is the Client API?

D
Written by Daria Nasedkina

Overview

Our client application programming interface (API) lets you pull and push data between the iHasco Atlas Learning Management System (LMS) and other software applications.

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

The API is language agnostic, so regardless of the programming languages your software uses, you can connect to and use it.

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

To start using the Client API, you'll need to enable API access and create an access token. See How to enable/disable the Client API.

We provide two different APIs suited to different use cases. You can access either one 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 don't 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 lets you access a large amount of related data in a single network request.

Use this API if:

  • You're comfortable with a more technical integration.

  • You only need to read data, not make inserts or updates.

  • You need 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.

Did this answer your question?