Skip to content
Browse the docs

Developer Guide

Overview

Show your Lernmark programmes on your own website. You can pull your live programme catalogue (titles, awards, durations, summaries, and whether applications are open) into your existing pages through a simple public API. It is included with your subscription, needs no secret API key, and is usually an afternoon of work for a web developer.

Which path is right for you?

Path A: Lernmark-hosted institution website

Choose this if your school has no website, or if you are happy to replace the one you have. Lernmark provides a ready-made, accessible, SEO-ready public site that stays connected to your programmes. Your team controls the editorial content. There is no code to maintain: only configuration.

The trade-off is that the site runs on the Lernmark platform. Contact us to discuss this option.

Path B: Add programmes to your existing website

Choose this if your school already has a website that you want to keep. A developer adds a small server-side integration, then presents the programme data in your existing design. This usually takes a few hours.

The trade-off is that your school owns the integration code and its presentation.

Your situationRecommended path
You do not have a website yetPath A
You have an established website to keepPath B
You do not have a developerPath A
You have a developer and want your own domain and designPath B
You want the least setup and maintenancePath A

The rest of this guide explains Path B.

The three rules

Build these rules into every integration

  1. Call the API from your server, not the browser. Cross-origin browser requests are blocked. Fetch on your server and render the result, or proxy the request through your own backend.
  2. Cache briefly. Keep successful responses on your server for 5–15 minutes. This keeps pages fast, covers brief outages, and respects the rate limit.
  3. Fail closed. On any error or timeout, show “Programme information is temporarily unavailable.” Never show stale or placeholder programme facts.

What you will build

You will:

  1. Find your tenant slug and institution ID.
  2. Read the public API contract.
  3. Copy a Node.js, PHP, or WordPress recipe.
  4. Show application availability safely.
  5. Add reliable error handling.