OpenApply propose une API publique permettant aux établissements scolaires d'accéder à leurs données et fichiers en toute sécurité. Que vous disposiez d'une équipe de développement dédiée (ou plus probablement d'un développeur talentueux en interne !) ou que vous fassiez appel à des prestataires externes pour développer votre infrastructure, vous pouvez intégrer OpenApply via l'API publique.
Faria Education Group propose une assistance pour l'API publique directement depuis les paramètres de votre compte OpenApply , sous : Paramètres > Développement > API publique ou Documentation de l'API.
En plus d'une suite complète d'API publiques, nous proposons également des articles d'assistance expliquant comment les utiliser pour réaliser les tâches les plus fréquemment demandées.
Vous trouverez ci-dessous quelques exemples d'instructions.
Exploration des API Faria Education Group : Portail d’intégration
Faria Education Group propose des API robustes pour OpenApply , ManageBac et SchoolsBuddy , répondant à de nombreux besoins d'intégration et d'automatisation. Faria recommande désormais d'utiliser le portail d'intégration pour une expérience simplifiée via navigateur, incluant des tests en direct avec vos propres identifiants.
Portail d'intégrations : l'approche recommandée
Le portail d'intégration est conçu pour l'exploration interactive des API et les tests en direct, directement dans votre navigateur.
Principaux avantages :
- Aucune installation de logiciel : tout fonctionne dans votre navigateur.
- Bouton « Tester » en direct : testez instantanément les points de terminaison de l’API et visualisez les réponses réelles.
- Gestion sécurisée des identifiants : authentifiez-vous à l’aide de vos propres clés API ou identifiants OAuth.
- Retour d'information immédiat : Dépannage et compréhension du comportement de l'API en temps réel.
Comment débuter :
- Consultez le portail des intégrations .
- Sélectionnez votre produit ( OpenApply , ManageBac , SchoolsBuddy ).
- Consultez la documentation de l'API et choisissez un point de terminaison.
- Cliquez sur le bouton « Tester » .
- Saisissez vos identifiants d'authentification (voir ci-dessous pour la configuration).
- Remplissez les champs obligatoires et soumettez la demande.
- Consultez la réponse en direct directement sur le portail.
Configuration de l'authentification :
-
OpenApply v3 :
- Accédez à OpenApply > Intégrations > API publique.
- Activez l'API publique et ajoutez une nouvelle application OAuth pour générer votre ID client et votre secret.
- Guide d'authentification de l'API OpenApply v3
- ManageBac+ v2 :
- Accédez à ManageBac > Paramètres > Intégrations > Accès API.
- Générez ou récupérez votre clé API.
- Guide d'authentification de l'API ManageBac+ v2
- SchoolsBuddy :
- Accédez à SchoolsBuddy > Paramètres > Gestionnaire d'API > Cliquez sur « Ajouter »
- Générez votre ID client et votre secret
-
Guide d'authentification de l'API SchoolsBuddy
Comment récupérer les fichiers liés aux étudiants depuis OpenApply via l'API
Problème : OpenApply sert de point d’entrée dans le processus d’admission ; les parents y téléchargent les photos d’identité et autres informations. Vous souhaiteriez pouvoir stocker ces données dans un autre système, ou éventuellement les importer dans le système d’information scolaire (SIS ou MIS) de votre établissement.
Solution : OpenApply dispose d’une fonction d’exportation qui vous permet d’exporter tous les fichiers en une seule fois, mais si vous recherchez un processus automatisé, vous pouvez utiliser les API pour y parvenir.
Remarques :
- L'accès à l'API est activé dans OpenApply (autorisations d'administrateur requises).
- ID client et secret OAuth 2.0 générés dans OpenApply :
- Connaissance des requêtes API et de l'authentification
Étapes impliquées :
- Nous prenons en charge l'utilisation de l'API pour obtenir toutes les informations sur les étudiants, y compris le filtrage et la récupération des mises à jour depuis le dernier appel. Ces informations incluent un lien secret vers les fichiers PDF soumis via le formulaire de candidature.
- Vous pouvez ensuite télécharger ces ressources en toute sécurité, les enregistrer sur votre disque dur ou les télécharger sur la plateforme cible.
Récupérer les dossiers des étudiants via l'API
Pour exporter les fichiers d'un étudiant en particulier :
GET /api/v3/students/{id}/files- Remplacez
{id}par l'identifiant de l'étudiant dans la base de données OpenApply . - Utilisez le paramètre
since_datepour récupérer uniquement les fichiers mis à jour depuis votre dernière exportation.
Exemple:
curl -X GET "https://api.openapply.com/api/v3/students/12345/files?since_date=2026-01-01" \ -H "Autorisation : Porteur VOTRE_JETON_D'ACCÈS"
La réponse inclut des métadonnées et des URL sécurisées pour chaque fichier, que vous pouvez télécharger et traiter selon vos besoins.
Automatiser et planifier les exportations
- Utilisez le paramètre
since_datepour récupérer uniquement les fichiers nouveaux ou mis à jour. - Planifiez l'exécution de votre intégration à intervalles réguliers (par exemple, chaque nuit) afin de maintenir votre système cible à jour.
- Stockez les identifiants API en toute sécurité et renouvelez-les selon les besoins.
Meilleures pratiques de sécurité
Comment télécharger des champs personnalisés et effectuer une recherche par champs personnalisés
Problème : Avec OpenApply , les établissements scolaires peuvent créer un nombre illimité de champs personnalisés pouvant être renseignés avec des données pertinentes. OpenApply offre également de nombreuses fonctionnalités d’exportation, mais comment utiliser l’API pour automatiser les processus et gérer nos flux de données ?
Solution : Cet article explique comment rechercher des informations dans les champs personnalisés à l’aide de l’API OpenApply avec l’authentification v3 . Le point de terminaison « students » inclut tous les champs personnalisés et leurs valeurs, s’ils sont renseignés pour l’étudiant concerné. De plus, vous pouvez utiliser un point de terminaison de recherche pour récupérer les étudiants dont les valeurs personnalisées correspondent à une chaîne de caractères.