Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

The "Get Details" operation for the "Article" resource in this node allows users to retrieve detailed information about a specific article from the Lectful API. This is useful when you want to fetch the full content and metadata of an article by its unique identifier.

Common scenarios where this node would be beneficial include:

  • Integrating article content into automated workflows or content management systems.
  • Fetching article details for review, editing, or display purposes.
  • Synchronizing article data between Lectful and other platforms.

For example, you might use this node to get the details of an article by providing its ID, then use the retrieved content in an email campaign or a website update.

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 that credentials can be left empty if overrides are provided.
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 retrieve details for. This property is required.

Output

The output of this operation is a JSON object containing the detailed information of the requested article as returned by the Lectful API. The structure typically includes fields such as the article's content, metadata, creation date, author info, and any other relevant attributes defined by the API.

No binary data is output by this operation.

Example output structure (simplified):

{
  "id": "string",
  "title": "string",
  "content": "string",
  "content_format": "markdown or delta",
  "created_at": "ISO8601 timestamp",
  "updated_at": "ISO8601 timestamp",
  "author_id": "string",
  // ... other article-specific fields
}

Dependencies

  • Requires access to the Lectful API.
  • Authentication can be done via stored credentials configured in n8n or manual entry of base URL and API key.
  • If using stored credentials, ensure they are properly set up with valid API base URL and API key.
  • No additional external dependencies beyond HTTP access to 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 Article ID: Providing an incorrect or non-existent article ID will result in an error from the API. Verify the article ID before running the node.
  • Network issues: Ensure that the n8n instance has network access to the Lectful API endpoint.
  • API errors: The node will throw errors if the API returns error responses (e.g., unauthorized, not found). Check the error message for details and verify authentication and input parameters.
  • Parsing errors: The node attempts to parse API responses as JSON. If the response is malformed, it may cause errors.

Links and References


This summary focuses specifically on the "Article" resource with the "Get Details" operation as requested.

Discussion