Som administratör kan du skapa API-nycklar för rotkonton. En API-utvecklarnyckel är en kod för en tredjepartsapp som utvecklaren får och som ger åtkomst till viss information och behörigheter i Canvas. API-utvecklarnyckel kan användas för att skapa anpassade integrationer med Canvas och tillåta tredjepartsappar att använda Canvas-autentisering. Utvecklarens API-nyckel använder OAuth2 för att aktivera appen för autentisering med Canvas. För mer information om OAuth2 se Dokumentation om Instructure API OAuth (Instructure API OAuth documentation).
API-utvecklarnyckeln skickas från appen till Canvas när en användare begär åtkomst. Appen ber användaren om behörighet att programmatiskt skapa en API-åtkomsttoken. När användaren godkänner appen får tredjepartsappen samma åtkomst till information och kontobehörigheter som användaren som gav åtkomsten. För mer information om utvecklardokument, se sidan Instructure Github.
Nyckelomfattning (Key Scoping)
API-utvecklarnycklar har en funktion för att ange nyckelns omfattning när en API-utvecklarnyckel läggs till. Med nyckelomfattning kan du kontrollera direktåtkomst till specifika API-slutpunkter för tredjepartsverktyg.
Obs! Utvecklarnycklar är ett kontotillstånd. Om du inte kan se länken Utvecklarnycklar i Kontonavigering, har detta tillstånd inte aktiverats för ditt användarkonto.
Öppna konto
I den globala navigeringen, klicka på länken Administratör (Admin) [1], och klicka sedan på namnet på kontot [2].
Öppna Utvecklarnycklar
I kontonavigeringen, klicka på länken Utvecklarnycklar (Developer Keys).
Lägg till Utvecklarnyckel
Klicka på knappen Lägg till utvecklarnyckel (Add Developer Key).
Lägg till API-nyckel
Klicka på alternativet Lägg till API-nyckel (Add API Key).
Ange nyckelinställningar
Ange inställningarna för API-utvecklarnyckeln:
- Nyckelnamn [1]: Vanligtvis namnet på din app eller ditt företag. Detta fält visas när användare ombeds att godkänna åtkomst till sina Canvas-konton på dina vägnar.
- Ägarens e-postadress [2]: E-postadress till personen som äger utvecklingsverktyget.
- Omdirigerings-URI:er [3]: Domänen där tokens begärs. Dessa URI:er är inte din Canvas-URL. Används https för att förhindra webbläsarproblem med blandat innehåll.
- Omdirigerings-URI (äldre) [4]: URI:n för nyckelns omdirigering. I detta fält kan du ange tidigare URI för ett verktyg. Detta fält kommer att bli borttaget så småningom.
- Leverantörskod (LTI 2) [5]: En unik registrerad kod som identifierar leverantören eller utvecklaren av ett tredjepartsverktyg. Detta gäller speciellt för LTI 2-verktyg och -appar.
- Ikon-URL [6]: URL:en för ditt utvecklarverktygs ikon. Den här URL:en visas för användaren så att denne kan godkänna ditt verktyg. Används https för att förhindra webbläsarproblem med blandat innehåll.
- Anteckningar [7]: Anteckningar om utvecklarnyckeln, som t.ex. varför den skapades.
- Testa endast klustret [8]: Skapar en utvecklarnyckeln som endast kan användas i Canvas-testmiljö.
- Tillämpa omfattningar [9]: Gör att du kan anpassa åtkomsten till nyckeln. I annat fall får nyckeln åtkomst till alla slutpunkter som är tillgängliga till den godkännande användaren.
Spara nyckel
Klicka på knappen Spara (Save).
Visa nyckel
Visa utvecklarnyckeln för ditt konto.
