Integrate Ally's API with an External Reporting Tool

Mae offer adroddiadau allanol yn cynnig nifer o fanteision, gan gynnwys patrymau data gwell, opsiynau addasu, a phrosesau awtomatig ar gyfer adroddiadau. Gall sefydliadau ddadansoddi setiau data cymhleth yn hawdd gan ddefnyddio amrywiaeth o fathau o siartiau, graffiau, a dangosfyrddau. Trwy addasu'r elfennau data a ddangosir, gallant deilwra adroddiadau i'w hanghenion penodol. Gydag adroddiadau awtomatig, mae defnyddwyr yn arbed amser ac adnoddau gwerthfawr, gan symleiddio'r broses o gynhyrchu adroddiadau.

Trwy gyfuno galluoedd nôl data API Ally â nodweddion patrymau data a dadansoddi uwch offer adroddiadau poblogaidd, gall sefydliadau ddatgloi mewnwelediadau i hwyluso penderfyniadau sy'n cael eu hysbysu gan ddata.

Mae croeso i chi adolygu'r ddogfennaeth dechnegol ar gyfer Pwyntiau Gorffen yr API Adroddiadau i ddysgu sut i osod ac addasu eich pwyntiau gorffen yn briodol.

Cyn i chi ddechrau arni

I integreiddio API Ally â'r offeryn adroddiadau o'ch dewis bydd angen y canlynol arnoch:

• Offeryn adroddiadau allanol fel Power BI, Tableau, Microsoft Excel, neu SAP Analytics, ymhlith eraill
• Mynediad i Adroddiad Sefydliadol Ally (Gweinyddwyr yn unig)
• Tocyn awdurdodi API (ar gael yn yr Adroddiad Sefydliadol)
• URL y Pwynt Gorffen (ar gael ar y dudalen help hon)
• Eich ID Cleient Ally (cysylltwch â'n tîm Cymorth os nad oes gennych yr ID hwn)

Cofiwch y bydd angen i chi newid rhwng y dudalen help hon, yr Adroddiad Sefydliadol, a'r offeryn adroddiadau allanol i osod popeth yn llwyddiannus. 

Sut i integreiddio API Ally ag offeryn adroddiadau allanol

• Cyrchwch eich Adroddiad Sefydliadol. Dysgu sut i gael mynediad i'r Adroddiad Sefydliadol.
• Yn y tab Trosolwg dewiswch y botwm Allgludo ar y dde.
• Dewiswch Cysylltu ag offer allanol.
    

• Bydd ffenestr foddol yn ymddangos gyda thocyn a gynhyrchir yn awtomatig. Dewiswch Copïo'r tocyn.

Mae tocynnau API yn dod i ben ar ôl blwyddyn. I gael tocyn newydd, dilynwch y canllaw hwn i osod eich offeryn adroddiadau allanol eto.    

• Ewch i'r offeryn adroddiadau allanol o'ch dewis. Ar gyfer yr enghraifft hon, byddwn yn dangos sut i osod API Ally â Power BI.
   

Mae gan offer adroddiadau allanol eraill ryngwynebau gwahanol, ond, maent i gyd yn dilyn camau tebyg fel y'u dangosir isod. Cyfeiriwch at ddogfennaeth eich offeryn adroddiadau os oes angen cymorth arnoch i osod eich ffynhonnell ddata. 
 

• Agorwch Power BI Desktop
• Dewiswch Cael Data o opsiynau'r tab Hafan. 
• Dewiswch Gwe o'r rhestr a ddangosir.
    

• Dewiswch yr opsiwn Uwch yn y ffenestr foddol O'r we. 
• Teipiwch Awdurdodi ym maes paramedr pennawd y cais HTTP.
• Yn y blwch testun i'r dde, teipiwch Cludwr, ychwanegwch fwlch, a gludwch y tocyn o'r Adroddiad Sefydliadol.
• Copïwch un o'r URLau Pwyntiau Gorffen canlynol:
  • https://[Rhanbarth]/api/v2/clients/[ID Cleient Ally]/reports/overall
  • https://[Rhanbarth]/api/v2/clients/[ID Cleient Ally]/reports/issues 

Mae modd rhannu data Adroddiad Ally yn adrannau Trosolwg a Phroblemau. Mae'r ddau yn cael eu defnyddio ar gyfer pob un o'ch cyrsiau yn eich sefydliad. Dewiswch URL y Pwynt Gorffen sy'n well gennych.  

• Gludwch URL y Pwynt Gorffen yn y maes llwybrau URL yn ffenestr ffodol O'r We Power BI.
• Rhowch eich ID Ally unigryw yn lle [ID Cleient Ally].

Os nad oes gennych yr ID hwn, cysylltwch â'n tîm Cymorth. Cofiwch mai'r ID Cleient Ally yw'r hwn, nid yr ID LMS.

• Newidiwch [Rhanbarth] yn seiliedig ar y rhanbarth mae amgylchedd Ally eich sefydliad wedi'i letya ynddi:
  • Canolfan ddata UDA: prod.ally.ac
  • Canolfan ddata Canada: prod-ca-central-1.ally.ac
  • Canolfan ddata Ewrop: prod-eu-central-1.ally.ac
  • Canolfan ddata Singapôr: prod-ap-southeast-1.ally.ac
  • Canolfan ddata Awstralia: prod-ap-southeast-2.ally.ac
• Unwaith y bydd y camau hyn wedi'u cwblhau, dylai ffenestr ffodol O'r We Power BI edrych fel hyn: 

• Dewiswch Iawn i ddechrau'r ymholiad yn seiliedig ar y wybodaeth a ddarparwyd.

Gan ddibynnu ar nifer y cofnodion, efallai bydd angen ychydig o amser paratoi ar y set ddata. Mae Ally yn ymateb gyda "statws" sy'n rhoi gwybod i'r defnyddiwr a yw'r data yn dal i gael ei brosesu. Yn Power BI, gallwch weld hyn drwy ddewis "Metaddata wedi'i ehangu" a chwilio'r golofn metadata.status:

Pan fydd y statws yn "Wrthi'n prosesu" bydd angen i chi aros nes bod y data yn barod. Dewiswch y botwm "Adnewyddu'r rhagolwg" ar y rhuban uchaf i alw'r API eto a gweld a yw'r data'n barod. Os yw'r set ddata yn barod, bydd yr holl gofnodion yn cael eu dangos a bydd y golofn metadata.status yn dangos y statws "Llwyddiannus".

• Yn olaf, dewiswch Cau a Defnyddio yn y gornel chwith uchaf.

Amser adnewyddu data 
Mae data ffynhonnell yn cael ei ddiweddaru'n fewnol bob 15 munud ar gyfer unrhyw un o'r pwyntiau gorffen. Ystyriwch hyn wrth alw ar y pwynt gorffen i nôl y data ar gyfer eich adroddiadau. 

Terfyn ymatebion
Cofiwch fod y terfyn ymatebion fesul galwad ar bwynt gorffen yn 10,000 o gofnodion. Os na ddangosir rhai cofnodion yn y 10,000 o gofnodion cyntaf, bydd angen i chi ddefnyddio opsiynau hidlo neu drefnu.