Integration Documentation - RutgersGRID/VIDAHub GitHub Wiki

Integration Documentation

Canvas LMS Integration

LTI (Learning Tools Interoperability) Integration

  1. Register your application as an LTI 1.3 tool in Canvas
  2. Implement the LTI launch flow in your application
  3. Manage authentication and context passing
  4. Enable deep linking for seamless navigation

Canvas API Integration

For deeper integration with Canvas data and features:

  1. Register your application as a developer app in Canvas
  2. Obtain OAuth2 credentials
  3. Implement the OAuth flow to get user tokens
  4. Use Canvas API to read/write course data

Canvas Developer Keys

For institution-wide deployment:

  1. Work with the Canvas administrator to obtain Developer Keys
  2. Configure your application with these keys
  3. Implement the appropriate authentication flows
  4. Enable single sign-on between Canvas and your tools

Embed via iframes

For simpler integration:

  1. Host your Streamlit apps with public URLs
  2. Use Canvas's HTML editor to embed your tools via iframes
  3. Consider using LTI for better authentication and content passing

API Documentation

Authentication

  • Authentication methods
  • Token management
  • Security best practices

Endpoints

[API endpoint documentation]

Data Models

[Data model documentation]

Error Handling

[Error response documentation]

Authentication Flows

User Authentication Flow

[Authentication flow documentation]

API Authentication Flow

[API authentication documentation]

Data Exchange Formats

JSON Schemas

[JSON schema documentation]

CSV Formats

[CSV format documentation]