Lectful icon

Lectful

Interact with the VIPay Lectful API

Actions88

Overview

This node interacts with the Lectful API to manage educational content and user data. Specifically, for the Section - Get operation, it retrieves detailed information about a specific section within a course by its ID. This is useful when you want to fetch metadata or details of a particular section in a course, such as its title, description, position, or other attributes managed by Lectful.

Practical examples:

  • Fetching a section's details to display in a custom dashboard.
  • Retrieving section info before updating or processing related lectures.
  • Integrating section data into external reporting or analytics tools.

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 only if Manual Configuration is selected, explaining credential usage.
Base URL Override Optional base URL to override the stored credential's base URL (without /api/v1).
API Key Override Optional API key to override the stored credential's API key.
Course ID The ID of the course that contains the section. Required to identify the course context.
Section ID The ID of the section to retrieve. Required to specify which section's details to fetch.

Output

The node outputs a JSON object representing the retrieved section's details from the Lectful API. This typically includes fields such as the section's title, description, position/order within the course, and potentially other metadata provided by the API.

Example output structure (simplified):

{
  "id": "section-id",
  "title": "Section Title",
  "description": "Description of the section",
  "position": 1,
  "course_id": "course-id",
  // ... other section-specific fields ...
}

No binary data is output by this operation.

Dependencies

  • Requires access to the Lectful API.
  • Requires either stored credentials configured in n8n or manual entry of the Lectful API 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 neither stored credentials nor manual overrides are properly set, the node will throw an error indicating missing or invalid credentials.
  • Base URL or API key missing in manual mode: When using manual configuration, both Base URL Override and API Key Override must be provided; otherwise, an error is thrown.
  • Invalid Course ID or Section ID: Providing incorrect or non-existent IDs will result in API errors, typically indicating resource not found.
  • API connectivity issues: Network problems or incorrect base URLs can cause request failures.
  • To resolve these, verify credentials, ensure correct IDs, and confirm network accessibility to the Lectful API endpoint.

Links and References

Discussion