Documentation Trainings
Trainings
Les formations
| Appel | Effet |
|---|---|
PUT /formations/{reference} |
crée la formation (201) ou la modifie (200) |
GET /formations/{reference} |
la formation et son état |
GET /formations?limite=100&curseur=… |
vos formations, de la plus récente à la plus ancienne, 100 au plus par page ; suivant donne le curseur de la page d'après (vide à la dernière) |
POST /formations/{reference}/pourvue |
la session est complète : la formation sort du site, archivée « pourvue » |
POST /formations/{reference}/fermer |
les inscriptions sont closes : la formation sort du site et de votre limite, ceux qui ont fait une demande sont prévenus ; état fermee (depuis la v1.11.0) |
POST /formations/{reference}/rouvrir |
une formation fermée revient en ligne, dans la limite de votre formule (403 sinon) |
GET /formations/{reference}/apercu |
la fiche telle qu'un membre la voit sur Heyalink (fiche), son état et le nombre de demandes (reponses) |
POST /formations/{reference}/pieces |
joindre des photos (photos, 6 au plus, JPEG, PNG, WebP ou HEIC, 10 Mo chacune ; la première est le visuel de l'annonce et de son partage) et des PDF (documents, 6 au plus, 20 Mo chacun), chacun {nom, donnees} en base64 (depuis la v1.12.0) |
PUT /formations/{reference}/pieces/ordre |
ranger les photos : ordre, les identifiants dans l'ordre voulu |
DELETE /formations/{reference}/pieces/{piece} |
retirer une photo ou un PDF (le fichier est effacé) |
POST /formations/{reference}/archivage |
la formation sort du site, archivée ; un PUT la ramène |
DELETE /formations/{reference} |
la retire (204, même si elle n'existait pas) |
POST /formations/lot |
jusqu'à 100 formations et 100 retraits en un appel |
POST /formations/synchronisation |
la liste complète de vos références en ligne : tout ce qui manque est archivé |
POST /formations/lheo |
votre catalogue LHEO, tel quel |
| Champ | Obligatoire | Contenu |
|---|---|---|
titre |
oui | l'intitulé, 200 caractères au plus |
presentation |
oui | le contenu de la formation, 15 000 caractères au plus ; HTML gardé en texte |
lien |
oui | l'adresse https:// de la fiche ou de l'inscription chez vous |
organisme |
non | l'organisme ; absent, le nom de votre page |
mode |
non | presentiel, distanciel ou mixte |
lieu |
non | la ville |
code_postal |
non | 5 chiffres |
duree_heures |
non | la durée en heures, un nombre entier |
debut |
non | la date de la prochaine session, AAAA-MM-JJ |
pour_qui |
non | le public visé |
niveau_d_entree |
non | le niveau demandé |
prerequis |
non | les prérequis |
objectifs |
non | les objectifs, 255 caractères au plus |
infos_pratiques |
non | prix, financement, horaires, 500 caractères au plus |
metier |
non | le métier visé, en texte (Conducteur d’engins de chantier) |
metier_code |
non | le code d'un métier du référentiel de Heyalink ; inconnu, la formation est refusée (422) |
famille_code |
non | le code d'une des 39 familles de métiers ; sans lui, la famille du métier |
code_rome |
non | le code ROME du métier visé (F1302) |
financements |
non | une liste prise dans cpf, opco, france_travail, region, employeur, sans doublon |
type_certification |
non | diplome (diplôme ou titre), habilitation (habilitation, CACES ou certificat) ou attestation |
code_rncp |
non | le code RNCP de France Compétences (RNCP34567) |
code_rs |
non | le code du Répertoire spécifique (RS5080) |
alternance |
non | une liste prise dans apprentissage, professionnalisation |
niveau_entree |
non | le niveau demandé, codé : aucun, cap, bac, bac2, bac3, bac5, bac8 (le texte libre niveau_d_entree reste) |
prix |
non | le prix total TTC par stagiaire, en euros ; toujours TTC, la fiche l'affiche « 1 500 € TTC » |
certification |
non | l'intitulé de la certification préparée (CAP Couvreur, CACES® R482 catégorie B1), 190 caractères au plus |
diplome |
non | le sigle du diplôme d'État préparé : CAP, BP, BTS, Bac pro, BUT… |
niveau_certification |
non | le niveau européen de la certification, de 1 à 8, avec un code_rncp seulement |
attestation |
non | true si la formation se termine par une attestation de fin de formation |
photo_url |
non | l'adresse https:// d'une photo de la formation : JPEG, PNG, GIF ou WebP, 5 Mo au plus |
photo_base64 |
non | la même photo en base64, à la place de photo_url |
Les champs à partir de metier (v1.6.0) sont facultatifs et suivent des listes fermées : une
valeur hors liste est refusée en 422, avec un exemple valide. Ils servent les filtres de
Formation : une formation sans la donnée sort du filtre correspondant (financement,
certification, alternance, niveau). « cpf » sans code RNCP ni RS est accepté, avec un
signalement incoherence.
La fiche de la formation (v1.8.0) se remplit avec ces champs, comme une formation saisie à la
main sur Heyalink. En tête, la carte « Ce que vous obtenez » : certification, le code
(code_rncp ou code_rs), le niveau sur 8 pour un RNCP (celui du répertoire national passe
devant niveau_certification) et la nature du titre (« Diplôme national » avec un diplome
d'État, « Certification » pour un code RS ; un code que le répertoire national ne connaît pas est
affiché comme déclaré par l'organisme). Sans certification, la carte devient « Ce que vous saurez
faire » et montre vos objectifs, puis la durée, puis l'attestation si attestation est vrai.
Sans l'un ni l'autre, pas de carte. La famille de métier est calculée par Heyalink (le titre
d'abord, puis famille_code) et rendue en lecture dans famille. La photo est facultative :
Heyalink la lit à l'adresse donnée (adresse publique seulement), la vérifie et la remet au propre
(2 000 px de large au plus). Illisible, la formation est refusée (422, champ photo_url). Une
photo absente de la requête reste ; photo_url envoyé à null la retire. Une nouvelle photo passe
ensuite par la vérification des images de Heyalink, comme une photo de profil : tant qu'elle est
vérifiée, photo rend la précédente ; refusée, elle n'est jamais publiée. Le prix (prix) est
toujours TTC : la fiche l'affiche « 1 500 € TTC ».
curl -X PUT "https://heyalink.com/api/formation/v1/formations/CACES-R482-B1" \
-H "Authorization: Bearer hl_formation_live_VOTRECLE" \
-H "Content-Type: application/json" \
-d '{
"titre": "CACES R482 catégorie B1",
"presentation": "Conduite en sécurité des pelles hydrauliques de moins de 6 tonnes.",
"lien": "https://www.votre-organisme.fr/formations/caces-r482-b1",
"mode": "presentiel",
"lieu": "Blagnac",
"code_postal": "31700",
"duree_heures": 21,
"debut": "2026-11-16"
}'
{
"formation": {
"reference": "CACES-R482-B1",
"titre": "CACES R482 catégorie B1",
"mode": "presentiel",
"lieu": "Blagnac",
"etat": "en_ligne",
"adresse": "https://heyalink.com/formations/caces-r482-categorie-b1-8",
"source": "api"
},
"avertissements": [],
"success": true
}
La réponse dit aussi ce qui s'est passé, dans resultat : creee, modifiee, restauree
(revenue en ligne), inchangee (rien n'a changé, rien n'est réécrit) ou doublon (le même
contenu est déjà en ligne sous une autre référence : rien n'est créé). Une formation peut
attendre avant de paraître (Grands comptes) : au plafond de facture du mois, ou sur une facture
impayée quatorze jours après son échéance, elle est enregistrée mais reste hors ligne. etat vaut
alors en_attente et attente dit pourquoi (motif : plafond ou impaye), depuis quand, et
parait_au_plus_tard_le. Le webhook annonce.en_attente vous prévient, puis annonce.publiee
quand elle paraît. Pour toute autre formation, attente vaut null. Les avertissements ne
bloquent jamais : ils disent ce qui manque pour bien ranger la formation (un lieu sans
département, par exemple).
Les signalements (signalements, depuis la v1.6.0) ne bloquent jamais non plus : code
champ_ignore (un champ que l'API ne connaît pas, ni publié ni refusé), champ_recommande_absent
(un champ qui manque, et la formation sortira du filtre qu'il remplit), valeur_deduite
(l'algorithme de Heyalink l'a déduit à votre place ; origine dit d'où : metier, code_rome,
titre, code_rncp, code_rs…) ou incoherence. Une valeur déduite est listée dans
champs_deduits, jamais présentée comme la vôtre.
Dans un catalogue LHEO (2.3), ces données se lisent sans saisie : domaine-formation/code-ROME,
organisme-financeur/code-financeur (2 Conseil régional, 4 France Travail, 5 Entreprise, 16
OPCO), certification/code-RNCP et code-RS, code-CPF (éligible au CPF), certifiante,
code-niveau-entree, prix-total-TTC et l'alternance des sessions
(session/cycle/alternance/type-alternance).
Relire une formation, et la liste de vos formations :
curl "https://heyalink.com/api/formation/v1/formations/CACES-R482-B1" \
-H "Authorization: Bearer hl_formation_live_VOTRECLE"
curl "https://heyalink.com/api/formation/v1/formations?limite=100" \
-H "Authorization: Bearer hl_formation_live_VOTRECLE"
La session est complète : la formation sort du site, archivée « pourvue ».
curl -X POST "https://heyalink.com/api/formation/v1/formations/CACES-R482-B1/pourvue" \
-H "Authorization: Bearer hl_formation_live_VOTRECLE"
Votre catalogue LHEO s'envoie aussi tel quel, en corps de requête (5 Mo au plus). Avec
?synchronisation=complete, les formations absentes du catalogue sont archivées.
curl -X POST "https://heyalink.com/api/formation/v1/formations/lheo?synchronisation=complete" \
-H "Authorization: Bearer hl_formation_live_VOTRECLE" \
-H "Content-Type: application/xml" \
--data-binary @catalogue-lheo.xml
Une formation masquée par la modération de Heyalink ne se republie pas (422) et ne se retire pas par l'API : écrivez à l'équipe si vous pensez à une erreur.
Supprimée ou fermée sur Heyalink (depuis la v1.11.0)
Un gérant de votre page peut fermer ou supprimer la formation sur Heyalink.
- Supprimée : elle ne revient jamais. Renvoyer la même référence (
PUT, envoi par lot) répond409,codeannonce_supprimee, avec la date (supprimee_le) et ce texte : « Cette annonce a été supprimée sur heyalink le … par un gérant de la page. Pour la republier, utilisez une nouvelle référence. » Un flux (page carrières, logiciel) la saute et le note dans son bilan (supprimees_sur_le_site) et dans le journal. - Fermée : renvoyée, elle se met à jour mais reste fermée (état
fermee) ; seul un gérant la rouvre, ou vous parPOST /formations/{reference}/rouvrir.
Envoyer par lot
Pour synchroniser un catalogue entier, envoyez jusqu'à 100 formations et 100 retraits par appel. Chaque formation a sa propre réponse : une formation refusée n'empêche pas les autres.
curl -X POST "https://heyalink.com/api/formation/v1/formations/lot" \
-H "Authorization: Bearer hl_formation_live_VOTRECLE" \
-H "Content-Type: application/json" \
-d '{
"formations": [
{
"reference": "CACES-R482-B1",
"titre": "CACES R482 catégorie B1",
"presentation": "Pelles de moins de 6 tonnes.",
"lien": "https://www.votre-organisme.fr/formations/caces-r482-b1"
},
{
"reference": "SST-2026-01",
"titre": "Sauveteur secouriste du travail",
"presentation": "Deux jours pour savoir porter secours.",
"lien": "https://www.votre-organisme.fr/formations/sst"
}
],
"retirer": ["HAB-2025-099"]
}'
La réponse donne un bilan (créées, modifiées, retirées, refusées) et, pour chaque formation,
son statut (201, 200 ou 422) avec le message d'erreur s'il y en a un.
La liste complète. POST /formations/synchronisation reçoit toutes vos références en ligne :
chaque formation de l'API qui n'y est pas est archivée. Une liste vide n'archive rien, sauf avec
"confirmer_liste_vide": true : une erreur d'envoi ne vide pas votre page.
curl -X POST "https://heyalink.com/api/formation/v1/formations/synchronisation" \
-H "Authorization: Bearer hl_formation_live_VOTRECLE" \
-H "Content-Type: application/json" \
-d '{"references": ["CACES-R482-B1", "SST-2026-01"]}'
Sans développement : votre catalogue
Sur l'écran API Formation, collez l'adresse https:// de votre catalogue : au format LHEO
(celui des Carif-Oref) ou en JSON (une liste de formations, ou un objet
{"formations": […]}, avec les champs de la table plus haut). Heyalink le relit et tient vos
formations à jour.
D'abord, prouvez que la source est la vôtre. Pour que personne ne publie vos formations à votre place, Heyalink ne lit une source qu'une fois prouvé qu'elle vous appartient. L'écran API Formation vous donne un jeton propre à la source, à poser d'une de ces façons, puis cliquez « Vérifier » :
- sur votre site, une balise dans l'en-tête de votre page d'accueil :
<meta name="heyalink-verification" content="VOTRE-JETON">; - ou un fichier texte
https://votre-site/.well-known/heyalink.txtqui contient le jeton.
Si vous ne pouvez pas poser le jeton, branchez-vous par l'API (plus haut) : POST /formations/lheo
envoie le même catalogue avec votre clé.
Laissez le jeton en place : Heyalink le revérifie chaque semaine. S'il disparaît, la source n'est plus lue et vous êtes prévenu par courriel.
Chaque lecture compare tout : une formation nouvelle est créée, une formation modifiée mise à jour, une formation disparue de votre catalogue archivée (jamais effacée : si elle revient, elle revient avec son adresse).
Prudence en cas de panne : une lecture en erreur ne retire rien ; un catalogue qui ne rend soudain plus aucune formation n'est vidé qu'au passage suivant, s'il est toujours vide. Au bout de trois erreurs de suite, ou dès qu'il se vide, vous êtes prévenu par courriel.
Fraîcheur : Heyalink relit votre catalogue toutes les 10 minutes au plus vite, plus rarement
s'il ne change pas (jusqu'à 6 heures), en requêtes conditionnelles (ETag, Last-Modified)
pour ne télécharger que ce qui change, et s'annonce comme HeyalinkBot. « Synchroniser
maintenant » se demande une fois toutes les cinq minutes au plus.
Tout de suite, si vous voulez : appelez l'adresse de mise à jour immédiate de votre
source (écran API Formation, « Mise à jour immédiate ») à chaque changement, Heyalink relit
votre catalogue dans la minute. Si votre catalogue annonce un hub WebSub, Heyalink s'y abonne
seul, avec un secret propre au hub (signatures sha1, sha256, sha384 ou sha512
acceptées).
curl -X POST "https://heyalink.com/api/formation/v1/sources/12/relire/VOTRE-SIGNATURE"
This section is written in French; the OpenAPI 3.1 specification describes every field.