Integrar l'API d'Ally amb una eina d'informes externa

Les eines d'informes externes ofereixen nombrosos avantatges, com ara visualització millorada de dades, opcions de personalització i processos automatitzats d'informes. Les institucions poden analitzar fàcilment conjunts de dades complexos mitjançant diversos tipus de gràfics, gràfics i escriptoris digitals. Amb la personalització dels elements de dades mostrats, poden adaptar els informes a les seves necessitats específiques. Amb els informes automatitzats, els usuaris estalvien temps i recursos valuosos, i racionalitzen la generació d'informes.

Si es combinen les funcionalitats de recuperació de dades de l'API d'Ally amb les funcions avançades de visualització i anàlisi de les populars eines d'informes, les institucions poden desbloquejar informació per facilitar les decisions basades en dades.

No dubteu a revisar la documentació tècnica dels extrems de l'API d'informes per obtenir informació sobre com configurar i personalitzar adequadament els extrems.

Abans de començar

Per integrar l'API d'Ally amb la vostra eina d'informes preferida, necessitareu el següent:

• Una eina d'informes externa com Power BI, Tableau, Microsoft Excel o SAP Analytics, entre d'altres
• Accés a l'informe institucional d'Ally (només administrador)
• Testimoni de l'API d'autorització (disponible a l'informe institucional)
• URL de l'extrem (disponible en aquesta pàgina d'ajuda)
• El vostre ID de client d'Ally (poseu-vos en contacte amb el servei d'atenció al client si no el teniu)

Tingueu en compte que haureu de canviar entre aquesta pàgina d'ajuda, l'informe institucional i l'eina d'informes externa per configurar-ho tot correctament.

Com integrar l'API d'Ally amb una eina d'informes externa

• Accediu al vostre informe institucional. Obteniu informació sobre com podeu accedir a l'informe institucional.
• A la pestanya Resum, seleccioneu el botó Exporta de la dreta.
• Seleccioneu Connecta l'eina externa.
  

• Es mostrarà un diàleg modal amb un testimoni generat automàticament. Seleccioneu Copia el testimoni.

Els testimonis de l'API caduquen al cap d'un any. Per obtenir un testimoni nou, seguiu aquesta guia per tornar a configurar l'eina d'informes externa.

• Aneu a la vostra eina d'informes externa preferida. Per donar un exemple, mostrarem com configurar l'API d'Ally amb Power BI.
  

Altres eines d'informes externes tenen interfícies diferents, però totes segueixen passos similars als que es mostren a continuació. Consulteu la documentació de l'eina d'informes si necessiteu ajuda per configurar la font de dades.

• Obriu l'escriptori del Power BI.
• Seleccioneu Obtén dades a les opcions de la pestanya Inici.
• Seleccioneu Web de la llista que es mostra.
  

• Seleccioneu l'opció Avançat en el diàleg modal Des de la web.
• Escriviu Autorització al camp del Paràmetre de capçalera de sol·licitud HTTP.
• Al quadre de text de la dreta, escriviu Portador, afegiu un espai i enganxeu el testimoni de l'informe institucional.
• Copieu un dels URL d'extrem següents:
  • https://[Region]/api/v2/clients/[Ally Client ID]/reports/overall
  • https://[Region]/api/v2/clients/[Ally Client ID]/reports/issues

Les dades de l'informe d'Ally es poden dividir en Resum i Incidències. Tots dos s'apliquen a tots els cursos de la vostra institució. Seleccioneu l'adreça URL de l'extrem que preferiu.

• Enganxeu l'adreça URL de l'extrem al camp Rutes de l'adreça URL del diàleg modal Des de la web del Power BI.
• Substituïu [Ally Client ID] pel vostre ID d'Ally únic.

Si no disposeu d'aquest ID, poseu-vos en contacte amb el servei d'atenció al client. Recordeu que és l'ID del client d'Ally, no l'ID del sistema de gestió de l'aprenentatge.

• Substituïu[Region] en funció de la regió on estigui allotjat l'entorn d'Ally de la vostra institució:
  • Centre de dades dels EUA:prod.ally.ac
  • Centre de dades canadenc:prod-ca-central-1.ally.ac
  • Centre de dades europeu:prod-eu-central-1.ally.ac
  • Centre de dades de Singapur:prod-ap-southeast-1.ally.ac
  • Centre de dades australià:prod-ap-southeast-2.ally.ac
• Un cop completats aquests passos, el diàleg modal Des de la web de Power BI hauria de tenir aquest aspecte:

• Seleccioneu D'acord per iniciar la consulta segons la informació proporcionada.

Segons el nombre de registres, el conjunt de dades pot necessitar un temps de preparació. Ally respon amb un “estat” que informa l'usuari si les dades encara s'estan processant. Al Power BI, podeu veure-ho seleccionant les “Metadades ampliades” i cercant a la columna metadata.status:

Tot i que l'estat és “S'està processant”, haureu d'esperar fins que les dades estiguin preparades. Seleccioneu el botó “Actualitza la vista prèvia” a la cinta superior per tornar a trucar a l'API i veure si les dades estan preparades. Si el conjunt de dades està preparat, es mostraran tots els registres i la columna metadata.status mostrarà l'estat “Correcte”.

• Finalment, seleccioneu “Tanca i aplica” a la part superior esquerra del corer.

Temps d'actualització de les dades
Les dades d'origen s'actualitzen internament cada 15 minuts per a qualsevol dels extrems. Tingueu en compte això quan invoqueu l'extrem per recuperar les dades dels informes.

Límit de resposta
Tingueu en compte que el límit de resposta per invocació d'extrem és de 10.000 registres. Si alguns registres no es mostren dins dels primers 10.000 registres, haureu d'utilitzar opcions de filtratge o ordenació.