Integration Documentation - RutgersGRID/VIDAHub GitHub Wiki
Integration Documentation
Canvas LMS Integration
LTI (Learning Tools Interoperability) Integration
- Register your application as an LTI 1.3 tool in Canvas
- Implement the LTI launch flow in your application
- Manage authentication and context passing
- Enable deep linking for seamless navigation
Canvas API Integration
For deeper integration with Canvas data and features:
- Register your application as a developer app in Canvas
- Obtain OAuth2 credentials
- Implement the OAuth flow to get user tokens
- Use Canvas API to read/write course data
Canvas Developer Keys
For institution-wide deployment:
- Work with the Canvas administrator to obtain Developer Keys
- Configure your application with these keys
- Implement the appropriate authentication flows
- Enable single sign-on between Canvas and your tools
Embed via iframes
For simpler integration:
- Host your Streamlit apps with public URLs
- Use Canvas's HTML editor to embed your tools via iframes
- 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]