Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

This node integrates with the Lectful API to manage articles and other educational resources. Specifically, the Article - Update operation allows users to update the content of an existing article by providing its ID, new content, and the content format.

Typical use cases include:

  • Updating course materials or documentation hosted on Lectful.
  • Automating content revisions in articles as part of a workflow.
  • Synchronizing article content from external sources into Lectful.

For example, you might use this node to update an article's content in Markdown or Quill Delta JSON format after editing it in another system.

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.
Article ID The unique identifier of the article to update.
Content The new content for the article.
Content Format The format of the content:
- Markdown: Markdown text format
- Delta (Quill JSON): Quill Delta JSON format for rich text editing

Output

The node outputs the response from the Lectful API as JSON in the json field of the output data. This typically contains the updated article details or confirmation of the update operation.

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 base URL and API key.
  • The API key must have permissions to update articles.

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 Article ID: Ensure the Article ID corresponds to an existing article in Lectful.
  • Content format errors: The content must match the specified format (markdown or delta). Invalid formatting may cause API errors.
  • API errors: The node will throw errors if the API returns failure responses. Check the error message for details and verify API permissions and input parameters.

Links and References

Discussion