Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

This node integrates with the Lectful API, enabling automation workflows to interact with various Lectful resources such as courses, users, enrollments, lectures, and more. Specifically, for the Enrollment - Get All operation, it retrieves a list of all enrollment records from the Lectful platform.

Typical use cases include:

  • Fetching all user enrollments in courses or learning paths for reporting or analytics.
  • Synchronizing enrollment data with other systems like CRMs or LMS platforms.
  • Automating administrative tasks related to managing enrollments.

Example: Automatically retrieve all enrollments daily to update an external database or trigger notifications based on enrollment status.

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)
Credentials Note Informational note shown when using Manual Configuration mode explaining credential usage.
Base URL Override Optional base URL to override the stored credential's base URL (exclude /api/v1).
API Key Override Optional API key to override the stored credential's API key.

These properties control how the node authenticates requests to the Lectful API.

Output

The node outputs an array of JSON objects representing the API response. For the "Enrollment - Get All" operation, the output JSON contains the list of all enrollments retrieved from the Lectful API endpoint /enrollments.

Each item in the output corresponds to one enrollment record, typically including fields such as enrollment ID, user ID, enrollable type (course, learning path, live event), enrollable ID, approval status, and other metadata as provided by the API.

No binary data is output by this operation.

Dependencies

  • Requires access to the Lectful API.
  • Requires either:
    • Stored credentials configured in n8n containing the Lectful API base URL and API key, or
    • Manual entry of Base URL and API key via the node parameters.
  • The node uses HTTP requests with Bearer token authentication to communicate with the Lectful API.

Troubleshooting

  • Missing or invalid credentials:
    Error thrown if neither valid stored credentials nor manual overrides are provided. Ensure credentials are correctly configured or manual parameters are filled.

  • Base URL Override missing in manual mode:
    When using manual authentication mode, the Base URL Override must be provided; otherwise, an error occurs.

  • API Key Override missing in manual mode:
    Similarly, the API key must be provided in manual mode.

  • Network or API errors:
    If the API endpoint is unreachable or returns an error, the node will throw an error. Check network connectivity and API key validity.

  • Parsing errors:
    The node attempts to parse string responses as JSON. If parsing fails, the raw string is returned. This usually indicates unexpected API response format.

Links and References


This summary focuses on the Enrollment resource with the Get All operation as requested.

Discussion