Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

This node integrates with the Lectful API to manage and interact with various educational resources, including videos. Specifically, the Video - Get Details operation retrieves detailed information about a specific video by its ID. This is useful for workflows that need to fetch metadata or status of a video hosted on the Lectful platform.

Common scenarios include:

  • Fetching video metadata to display in dashboards or reports.
  • Verifying video upload or processing status before triggering further actions.
  • Integrating video details into other systems or content management workflows.

Example: You have a workflow that processes new course content. After uploading a video, you use this node to get the video's details (like title, description, duration) to update your LMS or notify instructors.

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 Notice shown when using Manual Configuration mode 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.
Video ID The unique identifier of the video whose details you want to retrieve. (Required)

Output

The output is a JSON object containing the detailed information about the specified video as returned by the Lectful API. This typically includes fields such as:

  • Video metadata (title, description, duration, etc.)
  • Status information (upload status, processing state)
  • Possibly URLs or references to the video file or thumbnails

The exact structure depends on the Lectful API response but generally provides comprehensive data about the video resource.

No binary data output is produced 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 an 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 provided correctly, the node will throw an error indicating missing or invalid credentials. Ensure you configure valid API credentials or provide correct manual parameters.
  • Base URL Override required in manual mode: When using manual authentication mode, the base URL override must be provided; otherwise, an error is thrown.
  • Invalid Video ID: Providing an incorrect or non-existent video ID will result in an API error. Verify the video ID before running the node.
  • API connectivity issues: Network problems or incorrect base URL can cause request failures. Check network access and URL correctness.
  • Parsing errors: If the API returns unexpected data formats, the node attempts to parse JSON but may fail. Usually indicates API changes or errors.

Links and References

  • Lectful API Documentation (general reference for API endpoints and data structures)
  • n8n documentation on HTTP Request Node for understanding underlying request mechanics (similar to how this node operates internally).

Discussion