Skip to main content

REST API-integratie met Canvas-ontwikkelaarssleutel instellen

Canvas-ontwikkelaarssleutel is een krachtig alternatief voor de aanpak van toegangstokens, aangezien elk Canvas REST-eindpunt (bereik) kan worden ingeschakeld of uitgeschakeld voor integraties.

Als je de REST API-integratie wilt instellen, moet je de eerste deze dingen doen

  1. Maak een API-ontwikkelaarssleutel in je Canvas-omgeving

  2. Ally met de Canvas-ontwikkelaarssleutel configureren

Maak een API-ontwikkelaarssleutel aan

Een Canvas API-ontwikkelaarssleutel is in wezen een sleutel-ID en geheimpaar, gecombineerd met een specifieke configuratie van het bereik.

  1. Ga naar het rootaccount van de Canvas-instantie en ga naar Ontwikkelaarssleutels.

  2. Selecteer de knop Ontwikkelaarssleutel en selecteer API-sleutel.

  3. Geef waarden op voor Naam van sleutel en E-mail van eigenaar.

  4. Kopieer en plak deze koppeling naar het veld URI's omleiden. Vervang [AllyEnvironment] door de omgevingsinformatie waarin jouw instelling wordt gehost. Vervang [ClientID] door je Client ID.

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

  5. Selecteer de schakelaar Bereik afdwingen om de optie in te schakelen.

  6. Schakel het vakje Deelpunten toestaan in.

  7. Schakel het bereik in vanuit de tabel:

    tabel 7. Het bereik inschakelen

    Naam van bereik

    Sectie

    url:GET|/api/v1/accounts

    Accounts

    url:GET|/api/v1/accounts/:id

    Accounts

    url:GET|/api/v1/accounts/:account_id/sub_accounts

    Accounts

    url:GET|/api/v1/accounts/:account_id/courses

    Accounts

    url:GET|/api/v1/courses/:course_id/assignments

    Opdrachten

    url:GET|/api/v1/courses/:course_id/assignments/:id

    Opdrachten

    url:PUT|/api/v1/courses/:course_id/assignments/:id

    Opdrachten

    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions

    Blauwdrukcursussen

    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations

    Blauwdrukcursussen

    url:GET|/api/v1/courses/:course_id/content_migrations

    Inhoudsmigraties

    url:GET|/api/v1/courses/:id

    Cursussen

    url:PUT|/api/v1/courses/:id

    Cursussen

    url:POST|/api/v1/courses/:course_id/files

    Cursussen

    url:GET|/api/v1/courses/:course_id/discussion_topics

    Discussie-onderwerpen

    url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id

    Discussie-onderwerpen

    url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id

    Discussie-onderwerpen

    url:GET|/api/v1/accounts/:account_id/terms

    Inschrijvingsvoorwaarden

    url:GET|/api/v1/courses/:course_id/files

    Bestanden

    url:GET|/api/v1/courses/:course_id/files/:id

    Bestanden

    url:PUT|/api/v1/files/:id

    Bestanden

    url:DELETE|/api/v1/files/:id

    Bestanden

    url:GET|/api/v1/courses/:course_id/media_objects

    Mediaobjecten

    url:PUT|/api/v1/media_objects/:media_object_id

    Mediaobjecten

    url:GET|/api/v1/media_objects/:media_object_id/media_tracks

    Mediaobjecten

    url:PUT|/api/v1/media_objects/:media_object_id/media_tracks

    Mediaobjecten

    url:GET|/api/v1/courses/:course_id/pages

    Pagina's

    url:GET|/api/v1/courses/:course_id/pages/:url_or_id

    Pagina's

    url:PUT|/api/v1/courses/:course_id/pages/:url_or_id

    Pagina's

    url:GET|/api/v1/courses/:course_id/quizzes

    Quizzen

    url:GET|/api/v1/courses/:course_id/quizzes/:id

    Quizzen

    url:PUT|/api/v1/courses/:course_id/quizzes/:id

    Quizzen



  8. Selecteer Opslaan.

  9. De nieuwe sleutel wordt toegevoegd aan de pagina Ontwikkelaarssleutels en is standaard uitgeschakeld.

  10. Schakel de nieuwe sleutel in.

  11. Kopieer het sleutel-ID-nummer in de kolom Details.

Ally-omgeving voor je regio

Gebruik de informatie voor de Ally-omgeving waarin je instelling wordt gehost.

  • Amerikaans datacenter: prod.ally.ac

  • Canadees datacenter: prod-ca-central-1.ally.ac

  • Europees datacenter: prod-eu-central-1.ally.ac

  • Datacenter in Singapore: prod-ap-southeast-1.ally.ac

  • Australisch datacenter: prod-ap-southeast-2.ally.ac

Configureer Ally met de ontwikkelaarssleutel

Je moet zowel in je Canvas-omgeving als op je Ally-configuratiepagina zijn ingelogd.

  1. Ga naar de pagina Ally-configuratie en selecteer het tabblad Canvas-ontwikkelaarssleutel.

  2. Selecteer Configureer Ally met de Canvas-ontwikkelaarssleutel.

  3. Kopieer en plak de sleutel en het geheim van de API-ontwikkelaarssleutel die je hebt aangemaakt.

  4. Selecteer Opslaan en toegang verlenen.

  5. Selecteer Authorize om Ally toestemming te geven om de Canvas Developer Key te gebruiken.

Op de achtergrond voert Ally een (kleine) controle uit om ervoor te zorgen dat het juiste bereik is toegevoegd aan de Canvas-ontwikkelaarssleutel.

Als alles goed is, word je teruggeleid naar de configuratietool met het bericht dat je integratie juist is geconfigureerd.