Eduframe

Overview

The Eduframe module synchronizes course catalog data from Eduframe (a Student Information System for continuing education) into your Drupal website via API integration.

Eduframe is used by universities and colleges to manage courses and enrollments. This module enables institutions to publish their Eduframe course catalog on their Drupal website by automatically syncing course data, creating the necessary Drupal content structures, and keeping everything up-to-date.

Key Features

API Data Synchronization: Connects to your Eduframe instance to import course catalog data.
Automated Content Creation: Creates Drupal entities and taxonomy terms for catalog products, course variants, and categories.
Real-time Updates: Webhook support for immediate synchronization when course data changes in Eduframe.
Bulk Import: Queue-based processing for initial data import and periodic synchronization.
Admin Interface: Configuration page for API credentials and synchronization settings.

What Gets Synced

• Catalog products (courses).
• Catalog variants (course editions/variations).
• Categories and labels (taxonomy terms).
• Course locations (taxonomy terms).

Requirements

• Drupal 10 or 11.
• An active Eduframe account with API access credentials.
• Drieam Eduframe PHP Client Library (installed automatically via Composer).

Recommended Modules

For enhanced catalog display functionality, consider installing:

• Search API (for search functionality).
• Facets (for faceted filtering).
• Better Exposed Filters (for improved filter UX).

Post-Installation

1. Navigate to `/admin/config/services/eduframe`.
2. Enter your Eduframe API access token and base URL.
3. Configure webhook settings (optional, for real-time updates).
4. Run initial synchronization to import your course catalog.
5. For detailed technical documentation, see the README.md file of the module.

For security reasons it is recommended to put the access token in a .env file outside your web root instead of using it directly in the settings form.