Implementation Guidelines

Owned by Adaptemy
Jan 11, 2022
2 min read

Version Control

Adaptemy API v2 was introduced in 2020, and is not compatible with v1. All updates to the service will be backwards compatible, and use Semantic Versioning (Major.Minor.Patch).

Rate Limits and Capacity

There are no enforced rate limits. However please be aware that:

  1. Latency by geography: our API services are currently available at 4 worldwide locations (Ireland, Frankfurt, US, Singapore). If you are not close to these regions and are experiencing high latency, please contact us to enquire about adding a local region for your application.

  2. If you are serving below 50,000 concurrent learners, we would not expect any capacity issues. Above this number, please contact us to ensure we have the appropriate infrastructure in place to accommodate your needs.

Offline sessions and synchronisation

Your learning platform may offer offline sessions, during which time no communication is made with the Adaptemy API. When the learner is back online, you can use the Learner endpoint to synchronise with the Adaptemy engine.

Implementation Support

We want to ensure you have a happy implementation project with as few surprises as possible! Our typical implementation support services is as follows:

  1. Your account manager will discuss your implementation project with you and agree on the key phases and elements of support.

  2. Project workshop(s): in-depth sessions, usually at the start of the project, to plan out the implementation. Not just technical details, but the key concepts behind adaptive learning, curriculum maps, the learner profile, and designing good learning experiences.

  3. API Support helpdesk: for your daily questions on the details of the API endpoints.

  4. Analytics support: from our learning scientists, support to ensure that the adaptive learning models and recommendations are behaving as your expect, and the explain/explore any queries.