Fel gweinyddwr, gallwch chi greu allweddi API datblygwyr ar gyfer cyfrifon gwraidd. Mae allwedd API datblygwr yn god sy’n cael ei roi i ddatblygwr rhaglen trydydd parti sy’n caniatáu mynediad at wybodaeth a hawliau penodol yn Canvas. Mae modd defnyddio allweddi API datblygwyr i greu integreiddiadau personol gyda Canvas a gadael i apiau trydydd parti ddefnyddio dilysu Canvas. Mae’r allwedd API datblygwr yn defnyddio OAuth2 i alluogi’r rhaglen i ddefnyddio Canvas ar gyfer dilysu. I gael rhagor o wybodaeth am OAuth2, gweler dogfennau OAuth API Instructure.
Mae’r allwedd API datblygwr yn cael ei hanfon o’r rhaglen i Canvas pan mae’r defnyddiwr yn gofyn am fynediad. Mae’r rhaglen yn gofyn i’r defnyddiwr am hawl i greu tocyn mynediad API yn rhaglennol. Pan mae’r defnyddiwr yn awdurdodi’r rhaglen, bydd gan y rhaglen trydydd parti yr un mynediad at wybodaeth a hawliau cyfrif â'r defnyddiwr a roddodd fynediad. I gael rhagor o wybodaeth am ddogfennau datblygwr, gweler dudalen Github Instructure.
Cwmpasu Allwedd
Mae Allweddi API Datblygwyr yn cynnwys swyddogaeth ar gyfer cwmpasu allwedd fel rhan o ychwanegu allwedd API datblygwr. Mae cwmpasu allwedd yn gadael i chi reoli mynediad uniongyrchol at bwyntiau gorffen API penodol ar gyfer adnoddau trydydd parti.
Sylwch: Mae Allweddi Datblygwyr (Developer Keys) yn un o’r hawliau mewn cyfrif. Os na allwch chi weld dolen yr Allweddi Datblygwyr (Developer Keys) yn y ddewislen Crwydro’r Cyfrif, yna dydy’r hawl hon ddim wedi’i galluogi ar gyfer eich cyfrif defnyddiwr.
Agor Cyfrif
Yn y ddewislen Crwydro'r Safle Cyfan, cliciwch y ddolen Gweinyddwr (Admin) [1], yna cliciwch enw’r cyfrif [2].
Agor Allweddi Datblygwyr
Yn y ddewislen Crwydro’r Cyfrif, cliciwch y ddolen Allwedd Datblygwyr (Developer Keys).
Ychwanegu Allwedd Datblygwr
Cliciwch y botwm Ychwanegu Allwedd Datblygwr (Add Developer Key).
Ychwanegu Allwedd API
Cliciwch yr opsiwn Ychwanegu Allwedd API (Add LTI Key).
Rhoi Gosodiadau Allwedd
Rhoi’r gosodiadau ar gyfer yr allwedd API datblygwr:
- Enw Allwedd [1]: Enw eich ap neu gwmni fel arfer. Bydd y maes hwn yn cael ei ddangos pan mae gofyn i ddefnyddwyr gymeradwyo mynediad at eu cyfrif Canvas ar eich rhan.
- E-bost perchennog [2]: E-bost y person sy’n berchen ar yr adnodd datblygwr.
- Ailgyfeirio URIs [3]: Y parthau lle mae ceisiadau am docynnau’n cael eu gwneud. Nid eich URI Canvas yw’r URIs hyn. I osgoi pryderon am borwyr cynnwys cymysg, defnyddiwch https.
- URI Ailgyfeirio (Hen) [4]: Yr URI ar gyfer ailgyfeirio allwedd. Mae’r maes hwn yn gadael i chi osod yr URI blaenorol ar gyfer adnodd. Yn y pen draw bydd y maes hwn yn cael ei dynnu.
- Cod Gwerthwr (LTI 2) [5]: Cod cofrestru unigryw sy’n nodi gwerthwr neu ddatblygwr adnodd trydydd parti. Mae hyn yn benodol ar gyfer adnoddau ac apiau LTI 2.
- URL Eicon [6]: URL yr eicon ar gyfer eich adnodd datblygwr. Mae’r URL yn cael ei gyflwyno i’r defnyddiwr i gymeradwyo awdurdodi ar gyfer eich adnodd. I osgoi pryderon am borwyr cynnwys cymysg, defnyddiwch https.
- Nodiadau [7]: Unrhyw nodiadau am yr allwedd datblygwr, fel y rheswm y cafodd ei chreu.
- Clwstwr Prawf Yn Unig [8]: Creu allwedd datblygwr sydd ddim ond yn gallu cael ei defnyddio yn amgylchedd prawf Canvas.
- Gorfodi Cwmpasau [9]: Yn gadael i chi bersonoli mynediad ar gyfer yr allwedd. Neu, bydd gan yr allwedd fynediad at bob pwynt gorffen sydd ar gael i’r defnyddiwr sy'n awdurdodi.
Cadw Allwedd
Cliciwch y botwm Cadw (Save).
Gweld Allwedd
Ewch i weld yr Allwedd Datblygwr ar gyfer eich cyfrif.
