Skip to main content

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é.

 

Activation de l'API YParéo

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". 

image-1591796279143.png

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

image-1591796351267.png

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

image-1591796230804.png

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

  • GET /r/v1/periodes
  • GET /r/v1/nationalites
  • 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
  • GET /r/v1/document/repertoires-candidat
  • POST /r/v1/document/apprenant/@codeApprenant/document(/@codeTypeIdentifiantExterne)
  • POST /r/v1/document/prospect/@codeProspect/document(/@codeTypeIdentifiantExterne)
  • POST /r/v1/document/candidat/@codeCandidat/document(/@codeTypeIdentifiantExterne)
  • GET /r/v1/pays
  • POST /r/v1/preinscription/candidat
  • POST /r/v1/entreprises
  • GET /r/v1/entreprises
  • POST /r/v1/interlocuteurs
  • GET /r/v1(.1)/personnels
  • GET /r/v1/entreprises/@codeEntreprise/interlocuteurs
  • GET /r/v1/communes
  • GET /r/v1/rechercher/entreprises
  • GET /r/v1/conventions-collectives
  • POST /r/v1/document/prospect/@codeProspect/photo
  • POST /r/v1/document/prospect/@codeApprenant/photo
  • GET /r/v1/rechercher/apprenants

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

Afin de facilement profiter des nouvelles fonctions, nous vous recommandons de laisser tous les endpoints cochées.
Ceci vous permettra de ne pas avoir à régénérer de jeton.

 

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 commerciale 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".

image-1591797029471.png

Back to top