Integrer Allys API med et eksternt rapporteringsverktøy

Eksterne rapporteringsverktøy tilbyr mange fordeler, inkludert forbedret datavisualisering, tilpasningsalternativer og automatiserte rapporteringsprosesser. Institusjoner kan enkelt analysere komplekse datasett ved hjelp av en rekke diagramtyper, grafer og instrumentbord. Ved å tilpasse dataelementer som vises kan de skreddersy rapporter til sine spesifikke behov. Med automatisert rapportering sparer brukere verdifull tid og ressurser, noe som effektiviserer rapportgenereringen.

Ved å kombinere Allys API-datahentingsfunksjoner med de avanserte visualiserings- og analysefunksjonene i populære rapporteringsverktøy kan institusjoner få innsikt og legge til rette for datadrevne beslutninger.

Se gjerne gjennom den tekniske dokumentasjonen for rapportering av API-endepunkter for å finne ut hvordan du konfigurerer og tilpasser endepunktene dine på riktig måte.

Før du begynner

For å integrere Allys API med ditt foretrukne rapporteringsverktøy trenger du følgende:

• Et eksternt rapporteringsverktøy som Power BI, Tableau Microsoft Excel eller SAP Analytics
• Tilgang til Allys institusjonsrapport (bare administratorer)
• Autorisasjon API-token (tilgjengelig i institusjonsrapporten)
• Endepunktets URL (tilgjengelig på denne hjelpesiden)
• Din Ally-klient-ID (kontakt støtteteamet hvis du ikke har denne ID-en)

Husk at du må veksle mellom denne hjelpesiden, institusjonsrapporten og verktøyet for ekstern rapportering for å kunne konfigurere alt. 

Slik integrerer du Allys API med et eksternt rapporteringsverktøy

• Åpne institusjonsrapporten din. Finn ut hvordan du får tilgang til institusjonsrapporten.
• I Oversikt-fanen velger du Eksporter-knappen til høyre.
• Velg Koble til eksternt verktøy.
    

• En modal vises med et automatisk generert token. Velg Kopier token.

API-tokener utløper etter ett år. Hvis du vil ha et nytt token, følger du denne veiledningen for å konfigurere verktøyet for ekstern rapportering på nytt.    

• Gå til det foretrukne eksterne rapporteringsverktøyet. Ved hjelp av dette eksemplet viser vi hvordan du konfigurerer Allys API med Power BI.
   

Andre eksterne rapporteringsverktøy har ulike grensesnitt, men de følger alle lignende trinn som vist nedenfor. Se dokumentasjonen for rapporteringsverktøyet om du trenger hjelp til å konfigurere datakilden.  
 

• Åpne Power BI-skrivebord
• Velg Hent data fra alternativene på Hjem-fanen. 
• Velg Web fra listen som vises.
    

• Velg Avansert-alternativet i Fra web-modalen. 
• Skriv inn Autorisasjon i feltet for HTTP-forespørselshodeparameter.
• I tekstboksen til høyre skriver du Bærer, legger til et mellomrom og limer inn tokenet fra institusjonsrapporten.
• Kopier en av følgende URL-adresser for endepunkter:
  • https://[Region]/api/v2/clients/[Ally Client ID]/reports/overall
  • https://[Region]/api/v2/clients/[Ally Client ID]/reports/issues 

Allys rapportdata kan deles inn i Oversikt og Problemer. Begge gjelder for alle emnene dine ved din institusjon. Velg endepunkts-URL du foretrekker.  

• Lim inn endepunkts-URL i feltet UR-baner i Power BI-er Fra web-modal.
• Erstatt [Ally-klient-ID] med den unike Ally-ID-en din.

Hvis du ikke har denne ID-en, kan du kontakte støtteteamet vårt. Husk at dette er den Ally klient-ID-en, ikke LMS ID-en.

• Erstatt [Region] avhengig av regionen der det Ally miljøet for institusjonen din driftes:
  • Datasenter i USA: prod.ally.ac
  • Datasenter i Canada: prod-ca-central-1.ally.ac
  • Europeisk datasenter: prod-eu-central-1.ally.ac
  • Datasenter i Singapore: prod-ap-southeast-1.ally.ac
  • Australsk datasenter: prod-ap-southeast-2.ally.ac
• Når disse trinnene er fullført, skal Power BI-er Fra web-modal se slik ut: 

• Velg OK for å starte spørringen basert på informasjonen som er oppgitt.

Avhengig av antall poster, kan datasettet trenge litt klargjøringstid. Ally svarer med en «status» som informerer brukeren om dataene fortsatt behandles. I Power BI kan du se dette ved å velge «Utvidede metadata» og søke i metadata.status-kolonnen:

Mens statusen er «Behandler», må du vente til dataene er klare. Velg knappen «Oppdater forhåndsvisning» på toppbåndet for å ringe API igjen og se om dataene er klare. Hvis datasettet er klart, vises alle postene, og metadatastatus-kolonnen viser statusen «Vellykket».

• Til slutt velger du Lukk & påfør i venstre hjørne.

Tid for dataoppdatering%nbsp;
Kildedata oppdateres internt hvert 15. minutt for alle endepunktene. Vurder dette når du aktiverer endepunktet for å hente dataene til rapportene dine. 

Svargrense
Husk at svargrensen per aktivering av endepunkt er 10 000 oppføringer. Hvis enkelte poster ikke vises i de første 10 000 postene, må du bruke filtrerings- eller sorteringsalternativer.