Gosod integreiddiad API REST ag Allwedd Datblygwyr Canvas

Mae Allwedd Datblygwyr Canvas yn ddewis amgen cadarn i'r dull tocyn mynediad gan fod modd galluogi neu analluogi unrhyw bwynt gorffen (cwmpas) REST Canvas ar gyfer integreiddiadau.

I osod yr integreiddiad API REST, bydd angen i chi wneud y pethau hyn

Creu allwedd datblygwyr API yn eich amgylchedd Canvas
Ffurfweddu Ally ag allwedd datblygwyr Canvas

Creu allwedd datblygwr API

Mae Allwedd Datblygwyr API Canvas yn bâr rhif adnabod allwedd a chyfrinach wedi'i chyfuno â ffurfweddiad cwmpas penodol.

Ewch i gyfrif craidd yr enghraifft Canvas ac ewch i Allweddi datblygwyr.
Dewiswch y botwm+ Allwedd Datblygwyr a dewiswch Allwedd API.
Rhowch Enw'r Allwedd ac E-bost y Perchennog.
Copïwch a gludwch y ddolen yn y maes Ailgyfeirio URIs. Disodlwch [AllyEnvironment] gyda'r wybodaeth amgylchedd y mae eich sefydliad yn cael ei gynnal ynddo. Amnewid [ClientID] gyda'ch ID Cleient.
https://[AllyEnvironment]/api/v2/[ClientId]/auth/canvas/callback
Dewiswch y togl Gorfodi Cwmpasau i'w droi ymlaen.
Ticiwch y blwch ticio Caniatáu Paramedrau Cynnwys.

Galluogwch y cwmpasau hyn o'r tabl:

Tabl 7. Galluogwch y cwmpasau hyn

Enw'r cwmpas	Adran
`url:GET\|/api/v1/accounts`	Cyfrifon
`url:GET\|/api/v1/accounts/:id`	Cyfrifon
`url:GET\|/api/v1/accounts/:account_id/sub_accounts`	Cyfrifon
`url:GET\|/api/v1/accounts/:account_id/courses`	Cyfrifon
`url:GET\|/api/v1/courses/:course_id/assignments`	Aseiniadau
`url:GET\|/api/v1/courses/:course_id/assignments/:id`	Aseiniadau
`url:PUT\|/api/v1/courses/:course_id/assignments/:id`	Aseiniadau
`url:GET\|/api/v1/courses/:course_id/blueprint_subscriptions`	Cyrsiau Glasbrint
`url:GET\|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations`	Cyrsiau Glasbrint
`url:GET\|/api/v1/courses/:course_id/content_migrations`	Mudiadau Cynnwys
`url:GET\|/api/v1/courses/:id`	Cyrsiau
`url:PUT\|/api/v1/courses/:id`	Cyrsiau
`url:POST\|/api/v1/courses/:course_id/files`	Cyrsiau
`url:GET\|/api/v1/courses/:course_id/discussion_topics`	Pynciau Trafod
`url:GET\|/api/v1/courses/:course_id/discussion_topics/:topic_id`	Pynciau Trafod
`url:PUT\|/api/v1/courses/:course_id/discussion_topics/:topic_id`	Pynciau Trafod
`url:GET\|/api/v1/accounts/:account_id/terms`	Tymhorau Cofrestru
`url:GET\|/api/v1/courses/:course_id/files`	Ffeiliau
`url:GET\|/api/v1/courses/:course_id/files/:id`	Ffeiliau
`url:PUT\|/api/v1/files/:id`	Ffeiliau
`url:DELETE\|/api/v1/files/:id`	Ffeiliau
`url:GET\|/api/v1/courses/:course_id/media_objects`	Gwrthrychau Cyfryngau
`url:PUT\|/api/v1/media_objects/:media_object_id`	Gwrthrychau Cyfryngau
`url:GET\|/api/v1/media_objects/:media_object_id/media_tracks`	Gwrthrychau Cyfryngau
`url:PUT\|/api/v1/media_objects/:media_object_id/media_tracks`	Gwrthrychau Cyfryngau
`url:GET\|/api/v1/courses/:course_id/pages`	Tudalennau
`url:GET\|/api/v1/courses/:course_id/pages/:url_or_id`	Tudalennau
`url:PUT\|/api/v1/courses/:course_id/pages/:url_or_id`	Tudalennau
`url:GET\|/api/v1/courses/:course_id/quizzes`	Cwisiau
`url:GET\|/api/v1/courses/:course_id/quizzes/:id`	Cwisiau
`url:PUT\|/api/v1/courses/:course_id/quizzes/:id`	Cwisiau

Dewiswch Cadw.
Ychwanegir yr allwedd newydd at y dudalen Allweddi datblygwyr ac mae Wedi diffodd yn ddiofyn.
Trowch yr allwedd newydd ymlaen.
Copïwch rif ID yr allwedd yng ngholofn Manylion.

Amgylchedd cynghreiriaid ar gyfer eich rhanbarth

Defnyddiwch y wybodaeth ar gyfer yr amgylchedd Ally mae'ch sefydliad wedi'i letya ynddo.

Canolfan ddata UDA: prod.ally.ac
Canolfan ddata Canada: prod-ca-central-1.ally.ac
Canolfan ddata Ewropeaidd: prod-eu-central-1.ally.ac
Canolfan ddata Singapore: prod-ap-southeast-1.ally.ac
Canolfan ddata Awstralia: prod-ap-southeast-2.ally.ac

Ffurfweddu Ally â'r allwedd datblygwyr

Mae angen i chi fod wedi mewngofnodi i'ch amgylchedd Canvas a'ch tudalen Ally Configuration.

Ewch i'ch tudalen Ffurfweddu Ally a dewiswch dab Allwedd Datblygwyr Canvas.
Dewiswch Ffurfweddu Ally ag Allwedd Datblygwyr Canvas.
Copïwch a gludwch allwedd a chyfrinach yr allwedd datblygwr API a grëwyd gennych.
Dewiswch Cadw a rhoi mynediad.
Dewiswch Awdurdodi i roi caniatâd i Ally ddefnyddio'r Allwedd Datblygwr Canvas.

Yn y cefndir, bydd Ally yn rhedeg gwiriad cyflym (lleiaf) i sicrhau bod y cwmpasau cywir wedi'u hychwanegu at yr Allwedd Datblygwyr Canvas.

Os aiff popeth yn dda, dylech gael eich ailgyfeirio i'r offeryn ffurfweddu gyda neges yn dweud bod yr integreiddiad wedi'i ffurfweddu'n gywir.