Skip to content

Back to the plan Pro Formation

Pro Formation

The Training API

Your courses published from your website or software, and kept up to date on their own

You add, change or remove a course on your side: heyalink does the same on your business page. You never type anything twice.

Get Pro Formation at -50%

-50% on your first month, then €149 excl. VAT a month, no commitment

Read the technical documentation

Two ways to publish your courses

You choose. Both work together on the same business page.

By hand

On your business page, Training section: “Publish a course”. You fill in the form and it goes online. Handy for a few courses.

With every plan

Automatically, through the Training API

Your website or software sends your courses to heyalink. A course added, changed, full or removed on your side is too on heyalink.

Included in Pro Formation Grands comptes

What the API changes for you

  • Type it once

    Your courses live in your software. heyalink takes them as they are.

  • Always up to date

    A full session leaves heyalink. A course removed on your side is removed from heyalink too.

  • Easier to find

    Funding, CPF, RNCP, work-study, level: your courses enter the filters of the Training section.

  • You stay in control

    Every call is written to a log. A key is switched off in one click.

Three ways to connect your catalogue

  1. No development: the address of your catalogueYou give the address of your catalogue in LHEO, the Carif-Oref format, or JSON. heyalink reads it on its own: every 10 minutes at most, every 6 hours at least.
  2. Your catalogue sent in one callYour software sends the LHEO file to heyalink, 5 MB at most. Courses missing from the file can be archived at the same time.
  3. The API, course by courseYour software sends each course in JSON. An AI assistant can do it too, through the MCP server.

What the Training API does

Each course carries your reference, its code on your side. Sending the same reference twice updates the course: it is never published twice.

What the Training API does
What you doThe call
Publish a course, or update it PUT /formations/{reference}
Read a course and its status GET /formations/{reference}
List your courses, page by page GET /formations
Say a session is full: the course leaves heyalink POST /formations/{reference}/pourvue
Archive a course: it leaves heyalink and comes back if you send it again POST /formations/{reference}/archivage
Remove a course DELETE /formations/{reference}
Send up to 100 courses and 100 removals in one call POST /formations/lot
Send the full list of your references: API courses missing from it are archived POST /formations/synchronisation
Send your LHEO catalogue as it is, 5 MB at most POST /formations/lheo

Around the courses

  • Webhooksheyalink tells your website with a signed call when a course is online, waiting, hidden by moderation, past, archived, full, closed, reopened, deleted or refused on a photo or a PDF. 5 addresses at most.
  • The logThe latest calls and their result, kept 90 days. Also on the Training API screen.
  • Proof of your websiteYou prove the website of your courses is yours, with a tag or a file. Nobody publishes in your name.
  • The test keyThe same answers as a real key, without publishing. Test courses are deleted after 7 days.
  • Dry runWith a real key, the call is fully checked, but nothing is published.
  • The MCP serverYour AI assistants list, publish, archive and remove your courses.
  • OAuth 2.0For software that prefers it: your key is exchanged for a 60-minute token.
  • Key checkOne call tells which business page the key belongs to and what it may do.
  • API statusA public call, no key needed.

The details of a course

Three are required. The others rank your courses better in searches and filters.

Required

Title
titre
Description
presentation
Link to your course page or sign-up
lien

The session

Training provider
organisme
On site, remote or blended
mode
City
lieu
Postcode
code_postal
Length in hours
duree_heures
Date of the next session
debut
Price incl. VAT per trainee
prix
pro_formation.api.champs.libelles.photo_url
photo_url
pro_formation.api.champs.libelles.photo_base64
photo_base64

Who it is for

Target audience
pour_qui
Required level (free text)
niveau_d_entree
Required level (code)
niveau_entree
Prerequisites
prerequis
Objectives
objectifs
Practical information
infos_pratiques

The target trade

Trade, as text
metier
Trade code
metier_code
Trade family
famille_code
ROME code
code_rome

Funding and certification

Funding: CPF, OPCO, France Travail, Region, employer
financements
Diploma, licence or certificate
type_certification
RNCP code
code_rncp
RS code
code_rs
pro_formation.api.champs.libelles.certification
certification
pro_formation.api.champs.libelles.diplome
diplome
pro_formation.api.champs.libelles.niveau_certification
niveau_certification
pro_formation.api.champs.libelles.attestation
attestation
Apprenticeship or professionalisation
alternance

When a detail is missing, heyalink works it out when it can (the trade, from the ROME code or the title, for example) and tells you. It is never presented as yours.

The picture of a course is added on heyalink: it does not go through the API.

How to get access

The Training API is included in these plans: Pro Formation Grands comptes

The free business page and Pro do not have it.

  1. Subscribe your business page to Pro FormationAccess opens as soon as the plan is running.
  2. Open the Training API screenTraining section, “My courses”: “Connect my courses automatically”. The owner and the admins of the business page can open it.
  3. Create a key or invite your providerUp to 10 active keys, one per software. You can also invite up to 5 developers: they only see the API screen and their own keys.
  4. Prove your website, then publishA tag or a file on your website is enough. Then your courses go online.

If the plan stops, your keys stop answering, without being deleted. Everything resumes with the plan.

For your provider

Everything needed to connect your website or software. The documentation can be read without an account, before you subscribe.

Address
https://heyalink.com/api/formation/v1
Format
JSON in UTF-8; LHEO in XML for the catalogue
Description
OpenAPI 3.1, to import into Postman, Insomnia or a client generator
Key
In the Authorization header, one key per business page, for the Training API only
Limit
300 calls per minute and per key, 60 with a test key
Safe retries
Idempotency-Key header, valid 24 hours
Errors
RFC 9457 format, in French or English
Replacing a key
The old one keeps working 7 days, or stops at once after a leak

Your questions

Do I need a developer?

Not always. If your catalogue already has an LHEO or JSON address, you paste it on the Training API screen and add the tag or file to your website that proves it is yours. For the API, whoever runs your website does it with the documentation.

Can I publish by hand and through the API?

Yes. The API only touches the courses it published. Those typed by hand stay as they are.

Do API courses count in my plan?

Yes, like the others: 10 included with Pro Formation, then each extra course costs €10 excl. VAT a month up to the 20th, €5 from the 21st to the 50th, €2 beyond.

Can I try before publishing?

Yes. The test key gives the same answers as a real key and publishes nothing.

Pro Formation

Your catalogue published on its own, from this month

€149 excl. VAT a month · -50% on the first month

Get Pro Formation at -50%

-50% on your first month, then €149 excl. VAT a month, no commitment

Your cookie choices

With your consent, Heyalink measures site traffic with Google Analytics, and counts views of sponsored ads to bill their advertisers. Nothing is set before you choose, and declining changes nothing about how you use the site. Your choice is kept for six months; you can change it at any time with "Manage cookies" at the bottom of the page. Find out more

Customise

Nothing is set before you choose, and declining changes nothing about how you use the site. Your choice is kept for six months; you can change it at any time with "Manage cookies" at the bottom of the page. Find out more

Choose category by category