Settings › API access (/settings/api-access) lets your website, or the agency that builds it, show your trainings, courses with their dates, locations and licence categories, always up to date. Each website gets its own connection with a client ID and a secret. A connection only sees what this company offers: your published packages and the open courses that are still to start. It never sees customers, instructors or anything else.
How do I connect a website?
- Open Settings › API access. With more than one company, first choose the Company.
- Click New connection, give it a name (for example "School website") and click Save.
- Copy the Client ID and the Secret and give them to whoever runs your website, together with the Token URL and API URL shown on the page. The secret is shown only this once.
- Click I have stored it.
Your web developer uses the standard OAuth 2.0 client credentials flow: the website asks for a token at the token URL with the client ID and secret, then reads the catalogue at the API URL. The secret belongs on the website's server, never in the web page itself.
What does the website see?
- Trainings: the active products with Publish online switched on (not fees), with their price including VAT.
- Courses: open and full courses that are still to start, with their sessions, location and seats left. A full course is shown as full. Only courses whose package has Publish online switched on appear, so in-house or company courses stay off your website.
- Locations and licence categories (only the active ones; a switched-off category is no longer shown, also not on a course).
To change what appears, change the product (Publish online) or the course, as you do for the registration wizard.
How do I stop a website, or change the secret?
- New secret (the circular arrow): the old secret and everything handed out with it stop working at once. Give the new secret to the website.
- Switch off (the pause button): the connection stops at once, and everything handed out before stays invalid; switch it on again later with the play button. The website then signs in again with the same client ID and secret.
- Delete (the bin): the connection is removed for good.
Every new connection, new secret, name change, switch-off or -on and delete is listed under History at the bottom of the page, with who did it and when; a deleted connection stays listed there.
Do this straight away when a secret may have leaked or when you change web agency.
Good to know
- When your licence has expired, the connection stops: the website no longer gets a token or any data (message
license_expired) until the licence is renewed. Nothing needs to be changed on the website. - Only users whose role has Manage API access for websites see this page; the standard Administrator role has it. It requires two-step sign-in.
- Last used shows when the website last signed in.
- A company can have at most 10 connections.
Not possible (yet)
- Linking a training or course straight into the registration wizard from the website.
- Letting a website send registrations or questions through the API.
Did not find what you were looking for?
Submit a ticket