Skip to main content

Canvas Geliştirici Anahtarı ile REST API entegrasyonunu Ayarlama

Herhangi bir Canvas REST bitiş noktasını (kapsam) entegrasyonlar için etkinleştirmek veya devre dışı bırakmak mümkün olduğundan, Canvas Geliştirici Anahtarı erişim belirteci yaklaşımına karşı güçlü bir alternatiftir.

REST API entegrasyonunu ayarlamak için şunları yapmanız gerekir

  1. Canvas ortamınızda bir API geliştirici anahtarı oluşturun

  2. Canvas geliştirici anahtarı ile Ally'ı yapılandırın

Bir API geliştirici anahtarı oluştur

Canvas API Geliştirici Anahtarı, aslında belirli bir kapsam yapılandırması ile birleştirilmiş bir anahtar kimliği ve parola çiftidir.

  1. Canvas örneğinin ana hesabındaki Geliştirici anahtarları bölümüne gidin.

  2. + Geliştirici Anahtarı düğmesini tıklatın veAPI Anahtarı'nı seçin.

  3. Anahtar Adı ve Sahibinin E-posta Adresi bilgilerini girin.

  4. Şu bağlantıyı kopyalayıp Yönlendirme URI'leri alanına yapıştırın. [AllyEnvironment] yerine kurumunuzun barındırdığı ortam bilgisi ile değiştirin. "[ClientID]" yerine İstemci Kimliğinizi verin.

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

  5. Kapsamları Zorunlu Tut değiştirme düğmesini tıklatarak açın.

  6. Parametrelerin Dâhil Edilmesine İzin Ver onay kutusunu işaretleyin.

  7. Tablodan şu kapsamları etkinleştirin:

    Tablo 7. Şu kapsamları etkinleştirin

    Kapsam adı

    Bölüm

    url:GET|/api/v1/accounts

    Hesaplar

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

    Hesaplar

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

    Hesaplar

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

    Hesaplar

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

    Ödevler

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

    Ödevler

    url:PUT|/api/v1/courses/:course_id/ödevler/:id

    Ödevler

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

    Mavi Kopya Kurslar

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

    Mavi Kopya Kurslar

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

    İçerik Taşıma İşlemleri

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

    Kurslar

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

    Kurslar

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

    Kurslar

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

    Tartışma Konuları

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

    Tartışma Konuları

    url:PUT|/api/v1/courses/:course_id/tartışma_konuları/:topic_id

    Tartışma Konuları

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

    Kayıt Dönemleri

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

    Dosyalar

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

    Dosyalar

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

    Dosyalar

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

    Dosyalar

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

    Medya Nesneleri

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

    Medya Nesneleri

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

    Medya Nesneleri

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

    Medya Nesneleri

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

    Sayfalar

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

    Sayfalar

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

    Sayfalar

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

    Kısa Sınavlar

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

    Kısa Sınavlar

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

    Kısa Sınavlar



  8. Kaydet'i seçin.

  9. Yeni anahtar, Geliştirici anahtarları sayfasına eklenir ve varsayılan değeri Kapalı olarak atanır.

  10. Yeni anahtarı açın.

  11. Detaylar sütununda anahtar kimlik numarasını kopyalayın.

Bölgeniz için müttefik ortamı

Kurumunuzun barındırıldığı Ally ortamına ait bilgileri kullanın.

  • ABD veri merkezi: prod.ally.ac

  • Kanada veri merkezi: prod-ca-central-1.ally.ac

  • Avrupa veri merkezi: prod-eu-central-1.ally.ac

  • Singapur veri merkezi: prod-ap-southeast-1.ally.ac

  • Avustralya veri merkezi: prod-ap-southeast-2.ally.ac

Geliştirici anahtarı ile Ally'ı yapılandırma

Hem Canvas ortamınıza hem de Ally Yapılandırma sayfanıza giriş yapmış olmanız gerekir.

  1. Ally Yapılandırması sayfanıza gidin ve Canvas Geliştirici Anahtarı sekmesini seçin.

  2. Ally'ı Canvas Geliştirici Anahtarı ile Yapılandır'ı seçin.

  3. Oluşturduğunuz API geliştirici anahtarının anahtarını ve sırrını kopyalayıp yapıştırın.

  4. Kaydedin ve Erişim İzni Verin'i seçin.

  5. Ally'ye Canvas Geliştirici Anahtarı'nı kullanma izni vermek için Authorize seçeneğini seçin.

Ally, Canvas Geliştirici Anahtarı'na doğru kapsamların eklendiğine emin olunması için arka planda kısa (minimum seviyede) bir kontrol gerçekleştirir.

Her şey yolundaysa entegrasyonun doğru şekilde yapılandırıldığını bildiren bir iletiyle yapılandırma aracına geri yönlendirilmeniz gerekir.