Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

The "Get Course Progress" operation of the Lectful node retrieves the progress information of a user within a specific course from the Lectful API. This node is useful for educators, course administrators, or learning platforms that want to track and analyze how far users have progressed through a course. For example, it can be used to display progress dashboards, trigger notifications when milestones are reached, or integrate progress data into other systems.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful API:
- Use Stored Credentials
- Manual Configuration (provide base URL and API key manually)
Base URL Override Optional base URL to override the credential setting (without /api/v1). Used only in Manual Configuration mode.
API Key Override Optional API key to override the credential setting. Used only in Manual Configuration mode.
Course ID The ID of the course for which to retrieve the user's progress. This is a required field.

Output

The output is a JSON object representing the user's progress in the specified course. It contains detailed progress data as returned by the Lectful API endpoint /courses/{courseId}/progress. The exact structure depends on the API response but typically includes information such as completed lectures, percentage progress, scores, or timestamps related to the user's activity in the course.

No binary data output is produced by this operation.

Dependencies

  • Requires access to the Lectful API.
  • Requires either stored credentials configured in n8n (including base URL and API key) or manual entry of base URL and API key.
  • The node uses HTTP requests with Bearer token authentication to communicate with the Lectful API.

Troubleshooting

  • Missing or invalid credentials: If using stored credentials, ensure they are correctly configured with a valid base URL and API key. If using manual mode, both Base URL Override and API Key Override must be provided.
  • Invalid Course ID: Ensure the Course ID is correct and exists in the Lectful system; otherwise, the API will return an error.
  • API connectivity issues: Network problems or incorrect base URLs can cause request failures.
  • Error messages:
    • "Base URL Override is required when using Manual Configuration mode": Provide a valid base URL if manual mode is selected.
    • "API Key Override is required when using Manual Configuration mode": Provide a valid API key if manual mode is selected.
    • "Valid credentials are required when using 'Use Stored Credentials' mode.": Check stored credentials configuration.
    • Other API errors will be passed through; check the API response for details.

Links and References

Discussion