API documentation

Every institution has its own interactive API documentation, available at /docs/ from your Eduvem’s address - for example, https://love.eduvem.com/docs/. This is the material the technical team responsible for the integration (HR, ERP, BI or any external system) will use to learn about and test the API before writing any code.

What you’ll find there

The documentation brings together every endpoint of the integration API: accepted parameters, request and response schemas, and the scopes each call requires. The page is interactive - you can expand any endpoint, fill in the parameters and send the request straight from the browser, using a real token, with no need for Postman or any other external tool.

Where to find the link

On the institution settings’ Integrations tab (Institution > Integrations), the API Configuration for Integrations section shows:

• The API Documentation link, which opens your institution’s /docs/.
• The API URL, ready to copy - the base address used in every integration call.

Tip

Each institution has its own documentation, on its own domain. If you administer or integrate more than one Eduvem, always confirm which /docs/ you’re using - each institution’s is different.

Authentication

To test a call directly in the interactive documentation - or to set up a real integration - you need a valid API token. Creating, revoking and scoping tokens is managed on the same Integrations tab: see Integration API tokens. Without a token, the documentation stays browsable and every endpoint remains visible, but the send-request button returns an authentication error.

A content’s lectures

An integration that treats each lecture as its own task - a personal development plan in an HR system, for example - can fetch a content’s lecture list and, per enrollment, the status of each one:

• GET /integrations/courseVersions/{courseVersionUUID}/lessons returns the read-only, ordered list of the published content’s lectures - wizard lectures grouped by module, the SCOs of a SCORM package, or the single coursebox unit.
• GET /integrations/enrollments/{enrollmentUUID}/lessons returns the same list for a specific enrollment, with each lecture’s “visited”/“completed” status and the enrollment’s overall progress.

Both calls have their own usage limit: 120 requests per minute, per institution, for each one.

Every field, scope and full example for each endpoint is in your institution’s interactive API documentation (above).

Tip

Each lecture’s identifier (lessonKey) is the lecture’s identity; its position in the list (position) is display order only - if an author reorders the lectures, the position changes but the lessonKey stays the same. lessonKey stability also varies by content type: wizard lecture identifiers survive a republish and stay the same across translations. SCORM lecture identifiers, on the other hand, are the SCORM package’s own file paths - the identifiers can change or disappear if the package is replaced by a new version or, in the per-enrollment call, once the participant’s first launch pins a language whose package carries different files. An integration that stores this identifier (to track tasks, for example) needs to re-sync after any of these changes. Most SCORM content has a single lecture.

See also

• Integration API tokens