De API van Ally integreren met een externe tool voor rapportage

Externe tools voor rapportage bieden tal van voordelen, waaronder verbeterde gegevensvisualisatie, aanpassingsopties en geautomatiseerde rapportageprocessen. Instellingen kunnen complexe gegevenssets eenvoudig analyseren met behulp van verschillende diagramtypen, grafieken en dashboards. Door weergegeven gegevenselementen aan te passen, kunnen ze rapporten aanpassen aan hun specifieke behoeften. Met geautomatiseerde rapportage besparen gebruikers waardevolle tijd en bronnen en kunnen rapporten gestroomlijnd worden.

Door de API-mogelijkheden van Ally om gegevens op te halen te combineren met de geavanceerde visualisatie- en analysefuncties van populaire rapportagetools, kunnen instellingen inzichten ontgrendelen om gegevensgestuurde beslissingen te vergemakkelijken.

Raadpleeg de technische documentatie over API-eindpunten rapporteren om te lezen hoe je eindpunten op de juiste manier instelt en aanpast.

Voordat je begint

Het volgende is nodig om de API van Ally te integreren met je gewenste rapportagetool:

• Een externe tool voor rapportage zoals Power BI, Tableau Microsoft Excel of SAP Analytics, onder andere
• Toegang tot het instellingsrapport van Ally (alleen beheerders)
• Autorisatie API-token (beschikbaar in het Instellingsrapport)
• De URL van het eindpunt (beschikbaar op deze Help-pagina)
• Je client-ID van Ally (neem contact op met het ondersteuningsteam als je deze ID niet hebt)

Houd er rekening mee dat je moet schakelen tussen deze Help-pagina, het Instellingsrapport en de externe tool voor rapportage om alles in te kunnen stellen. 

De API van Ally integreren met een tool voor externe rapportage

• Je instellingsrapport openen. Ontdek hoe je het instellingsrapport kunt openen
• Selecteer op het tabblad Overzicht aan de rechterkant de knop Exporteren.
• Selecteer Externe tool verbinden.
    

• Er wordt een modaal weergegeven met een automatisch gegenereerde token. Selecteer token kopiëren.

API-tokens verlopen na een jaar. Volg deze handleiding om je externe tool voor rapportage opnieuw in te stellen als je een nieuw token wilt aanvragen.    

• Ga naar je gewenste externe tool voor rapportage. Door middel van dit voorbeeld geven we aan hoe je de API van Ally met Power BI instelt.
   

Andere externe rapportagetools hebben verschillende interfaces. Ze volgen echter allemaal dezelfde stappen zoals hieronder weergegeven. Raadpleeg de documentatie van je rapportagetool als je hulp nodig hebt bij het instellen van je gegevensbron.  
 

• Power BI Desktop openen
• Selecteer Gegevens ophalen vanuit de opties op het tabblad Start. 
• Selecteer Web in de weergegeven lijst.
    

• Selecteer de optie Geavanceerd in de modaal Van web. 
• Typ Autorisatie in het veld koptekstparameter HTTP-aanvraag.
• Typ Bearer in het tekstvak aan de rechterkant, voeg een spatie toe en plak het token uit het Instellingsrapport.
• Kopieer een van de volgende eindpunt-URL's:
  • https://[regio]/api/v2/clients/[Ally client-ID]/reports/overall
  • https://[regio]/api/v2/clients/[Ally client-ID]/reports/issues 

De rapportgegevens van Ally kunnen worden verdeeld in Overzicht en Problemen. Allebei zijn van toepassing op al je cursussen bij je instelling. Selecteer je gewenste eindpunt-URL.  

• Plak de eindpunt-URL in het veld URL-paden in de modaal Van web van Power BI.
• Vervang [Ally client-ID] door je unieke Ally-ID.

Neem contact op met het ondersteuningsteam als je deze ID niet hebt. Let op: het gaat om de Ally client-ID en niet de LMS-ID.

• Vervang [regio] afhankelijk van de regio waarin de Ally-omgeving van je instelling wordt gehost:
  • Datacenters in de Verenigde Staten: prod.ally.ac
  • Datacenters in Canada: prod-ca-central-1.ally.ac
  • Datacenters in Europa: prod-eu-central-1.ally.ac
  • Datacenters in Singapore: prod-ap-southeast-1.ally.ac
  • Datacenters in Australië: prod-ap-southeast-2.ally.ac
• Zodra deze stappen zijn voltooid, zou de modaal Van web van Power BI er zo uit moeten zien: 

• Selecteer OK om de query te starten op basis van de aanwezige informatie.

Afhankelijk van het aantal records kan er enige voorbereidingstijd nodig zijn voor de gegevensset. Ally antwoordt met een ‘status’ die de gebruiker vertelt of de gegevens nog verwerkt worden. In Power BI kun je dit zien door de 'Uitgevouwen metagegevens' te selecteren en in de kolom metadata.status te zoeken:

Zolang de status ‘Verwerken’ is, moet je wachten tot de gegevens klaar zijn. Selecteer de knop 'Voorbeeld vernieuwen' in het bovenste lint om de API opnieuw aan te roepen en te kijken of de gegevens klaar zijn. Als de gegevensset gereed is, worden alle records weergegeven en toont de kolom metadata.status de status ‘Gelukt’.

• Selecteer ten slotte Sluiten en toepassen in de linkerbovenhoek.

Vernieuwingstijd van gegevens 
Brongegevens worden intern om de 15 minuten bijgewerkt voor elk van de eindpunten. Houd hier rekening mee wanneer je het eindpunt opent om de gegevens voor je rapporten op te halen. 

Reactielimiet
Houd er rekening mee dat de reactielimiet per aanroeping van een eindpunt 10.000 records is. Als sommige records niet worden weergegeven binnen de eerste 10.000 records, moet je filter- of sorteeropties gebruiken.