Instructions de migration vers l'API REST

Prérequis

Afin d’utiliser le nouveau module d’intercommunication YParéo, vous devez disposer d’au minimum de la version 3.7.16 d’YParéo mais nous recommandons les versions 3.7.17 et plus pour une meilleure compatibilité.

 

Migration

Pour activer l'API REST : 

1. Vous devez ajouter un prestataire REST dans votre instance YParéo.

Pour ce faire, allez dans "Paramètres", puis "Administration". 

Dans l'interface, sélectionnez "Modules" puis "Prestataires webservices REST".

Il vous suffira ensuite de cliquer sur le bouton "Ajouter un prestataire".

2. Puis, il vous faut sélectionner les endpoints que vous autoriser le module à utiliser. Nous avons besoin au minimum de :

• GET /r/v1/periodes
• GET /r/v1/sites
• GET /r/v1/formations
• GET /r/v1/formation-longue/apprenants
• GET /r/v1/formation-longue/prospects
• GET /r/v1/document/repertoires-apprenant
• GET /r/v1/document/repertoires-prospect
• POST /r/v1/document/apprenant/@codeApprenant/document
• POST /r/v1/document/prospect/@codeProspect/document
• GET /r/v1/pays
• GET /r/v1/identifiants-externes/types
• GET /r/v1/identifiants-externes/types/@codeTypeIdentifiantExterne/tables
• GET /r/v1/identifiants-externes/@codeTypeIdentifiantExterne/@codeTable
• POST /r/v1/preinscription/candidat
• POST /r/v1/entreprises
• GET /r/v1/entreprises
• POST /r/v1/interlocuteurs
• GET /r/v1/personnels
• GET /r/v1/entreprises/@codeEntreprise/interlocuteurs
• GET /r/v1/communes

Mais d’autres endpoints pourraient rejoindre cette liste lors d’éventuelles mises à jour.

 

3. Vous devez ensuite valider la création pour obtenir un jeton d’authentification à l’API REST d’YParéo.

 

4. Ensuite, il vous faut prendre contact avec notre équipe commercial afin de nous communiquer l’url d’accès à votre environnement netYparéo ainsi que le jeton crée.

Vous pouvez trouver ce jeton à n'importe quel moment dans l'interface "Prestataire webservices REST".