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

  1. Creu allwedd datblygwyr API yn eich amgylchedd Canvas
  2. Ffurfweddu Ally ag allwedd datblygwyr Canvas

Creu allwedd datblygwyr API

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

  1. Ewch i gyfrif craidd yr enghraifft Canvas ac ewch i Allweddi datblygwyr.
  2. Dewiswch y botwm+ Allwedd Datblygwyr a dewiswch Allwedd API.
  3. Rhowch Enw'r Allwedd ac E-bost y Perchennog.
  4. Copïwch a gludwch y ddolen hon yn y maes Ailgyfeirio URIs. Disodlwch [AllyEnvironment] gyda gwybodaeth am yr amgylchedd mae'ch sefydliad wedi'i letya ynddo. Disodlwch [ClientID] gyda’ch ID Cleient.

    https://[AllyEnvironment]/api/v2/[ClientId]/auth/canvas/callback

  5. Dewiswch y togl Gorfodi Cwmpasau i'w droi ymlaen.
  6. Ticiwch y blwch ticio Caniatáu Paramedrau Cynnwys.
  7. Galluogwch y cwmpasau hyn o'r tabl:
    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/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
  8. Dewiswch Cadw.
  9. Ychwanegir yr allwedd newydd at y dudalen Allweddi datblygwyr ac mae Wedi diffodd yn ddiofyn.
  10. Trowch yr allwedd newydd ymlaen.
  11. Copïwch rif ID yr allwedd a'r cyfrinach yng ngholofn Manylion. 

Amglychedd Ally ar gyfer eich rhanbarth

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

  • Canolfan data yn yr UD: prod.ally.ac
  • Canolfan data yng Nghanada: prod-ca-central-1.ally.ac
  • Canolfan data yn Ewrop: prod-eu-central-1.ally.ac
  • Canolfan data yn Singapore: prod-ap-southeast-1.ally.ac
  • Canolfan data yn Awstralia: prod-ap-southeast-2.ally.ac

Ffurfweddu Ally â'r allwedd datblygwyr

Mae angen i chi fod wedi mewngofnodi yn eich amgylchedd Canvas ac ar eich tudalen Ffurfweddu Ally.

  1. Ewch i'ch tudalen Ffurfweddu Ally a dewiswch dab Allwedd Datblygwyr Canvas.
  2. Dewiswch Ffurfweddu Ally ag Allwedd Datblygwyr Canvas.
  3. Copïwch a gludwch allwedd a chyfrinach yr allwedd datblygwyr API a greoch.
  4. Dewiswch Cadw a rhoi mynediad.
  5. Dewiswch Awdurdodi i ganiatáu i Ally ddefnyddio'r Allwedd Datblygwyr 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.