Intégration de l'API Ally à un outil de création de rapports externe

Les outils de création de rapports externes offrent de nombreux avantages, notamment une visualisation améliorée des données, des options de personnalisation et des processus de création de rapports automatisés. Les établissements peuvent facilement analyser des ensembles de données complexes à l'aide d'une variété de types de tableaux, de graphiques et de tableaux de bord. En personnalisant les éléments de données affichés, ils peuvent adapter les rapports à leurs besoins spécifiques. Avec la création de rapports automatisée, les utilisateurs rationalisent la génération de leurs rapports et économisent ainsi des ressources et un temps précieux.

En combinant les fonctionnalités d'extraction de données de l'API Ally aux fonctionnalités avancées de visualisation et d'analyse des outils de création de rapports les plus courants, les établissements peuvent accéder aux informations nécessaires pour prendre des décisions basées sur les données.

N'hésitez pas à consulter la documentation technique relative aux points de terminaison d'API de création de rapports pour savoir comment configurer et personnaliser vos points de terminaison de manière appropriée.

Avant de commencer

Pour intégrer l'API Ally à votre outil de création de rapports préféré, vous aurez besoin des éléments suivants :

• un outil de création de rapports externe tel que Power BI, Tableau, Microsoft Excel ou SAP Analytics, par exemple
• un accès au rapport d'établissement Ally (administrateur uniquement)
• un jeton d'API d'autorisation (disponible dans le rapport d'établissement)
• l'URL du point de terminaison (disponible sur cette page d'aide)
• votre code client Ally (contactez notre équipe d'assistance si vous ne disposez pas de cet identifiant)

Gardez à l'esprit que vous devrez basculer entre cette page d'aide, le rapport d'établissement et l'outil de création de rapports externe pour tout configurer correctement.

Comment intégrer l'API Ally à un outil de création de rapports externe

• Accédez à votre rapport d'établissement Découvrir comment accéder au rapport d'établissement.
• Dans l'onglet Vue d'ensemble, sélectionnez le bouton Exporter situé à droite.
• Sélectionnez Connecter un outil externe.
  

• Une fenêtre modale s'affiche avec un jeton généré automatiquement. Sélectionnez Copier le jeton.

Les jetons d'API expirent après un an. Pour obtenir un nouveau jeton, suivez ce guide afin de reconfigurer votre outil de création de rapports externe.

• Accédez à l'outil de création de rapports externe de votre choix. Dans cet exemple, nous allons montrer comment configurer l'API Ally avec Power BI.
  

D'autres outils de rapports externes ont des interfaces différentes, mais leur configuration passe toujours par des étapes similaires à celles décrites ci-dessous. Reportez-vous à la documentation de votre outil de création de rapports si vous avez besoin d'aide pour configurer votre source de données.

• Ouvrez Power BI Desktop.
• Sélectionnez Obtenir des données à partir des options de l'onglet Accueil.
• Sélectionnez Web dans la liste affichée.
  

• Sélectionnez l'option Avancé dans la fenêtre modale À partir du Web.
• Saisissez Autorisation dans le champ Paramètres d'en-tête de requête HTTP.
• Dans la zone de texte de droite, saisissez Bearer , ajoutez une espace, puis collez le jeton du rapport d'établissement.
• Copiez l'une des URL de point de terminaison suivantes :
  • https://[Region]/api/v2/clients/[Ally Client ID]/reports/overall
  • https://[Region]/api/v2/clients/[Ally Client ID]/reports/issues

Les données du rapport Ally peuvent être divisées en deux sections : Vue d'ensemble et Problèmes. Les deux s'appliquent à tous les cours que vous avez dispensés dans votre établissement. Sélectionnez l'URL de point de terminaison que vous préférez.

• Collez l'URL de point de terminaison dans le champ Chemins d'accès URL de la fenêtre modale À partir du Web de Power BI.
• Remplacez [Ally Client ID] par votre code client unique Ally.

Si vous ne disposez pas de ce code, contactez notre équipe d'assistance. N'oubliez pas qu'il s'agit du code client Ally, et non de l'identifiant LMS.

• Remplacez [Region] par la région où l'environnement Ally de votre établissement est hébergé.
  • Centre de données pour les États-Unis : prod.ally.ac
  • Centre de données pour le Canada : prod-ca-central-1.ally.ac
  • Centre de données pour l'Europe : prod-eu-central-1.ally.ac
  • Centre de données pour Singapour : prod-ap-southeast-1.ally.ac
  • Centre de données pour l'Australie : prod-ap-southeast-2.ally.ac
• Une fois ces étapes terminées, la fenêtre modale À partir du Web de Power BI doit ressembler à ceci :

• Sélectionnez OK pour lancer la requête en fonction des informations fournies.

Selon le nombre d'enregistrements, l'ensemble de données peut nécessiter un certain temps de préparation. Ally répond par un « statut » qui indique si les données sont toujours en cours de traitement. Dans Power BI, vous pouvez accéder à cette information en sélectionnant « Métadonnées développées » et en effectuant une recherche dans la colonne metadata.status :

L'état « Traitement » nécessite d'attendre que les données soient prêtes. Sélectionnez le bouton « Actualiser aperçu avant impression » dans le ruban supérieur pour appeler à nouveau l'API et savoir si les données sont prêtes. Si l'ensemble de données est prêt, tous les enregistrements s'affichent et la colonne metadata.status indique l'état « Réussi ».

• Enfin, sélectionnez « Fermer et appliquer », en haut à gauche.

Délai d'actualisation des données
Les données sources sont mises à jour en interne toutes les 15 minutes pour tous les points de terminaison. Tenez compte de ce délai lorsque vous appelez un point de terminaison pour récupérer les données de vos rapports.

Limite de réponse
Gardez à l'esprit que la limite de réponse par appel de point d'arrêt est de 10 000 enregistrements. Si certains ne s'affichent pas dans les 10 000 premiers enregistrements, vous devrez utiliser des options de filtrage ou de tri.