Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

This node interacts with the Lectful API to manage blog tags in an administrative context. Specifically, the "Get Tag (Admin)" operation retrieves detailed information about a specific blog tag by its ID. This is useful for administrators who need to fetch metadata or details about a particular tag used in blog posts, such as its name and associated properties.

Common scenarios:

  • Fetching tag details to display or edit in an admin dashboard.
  • Validating the existence or properties of a tag before associating it with blog posts.
  • Integrating blog tag data into other workflows or systems via n8n automation.

Practical example:
An administrator wants to automate the process of syncing blog tags from Lectful to another CMS. Using this node's "Get Tag (Admin)" operation, they can retrieve each tag's details by ID and then push that data to the external 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)
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.
Tag ID The unique identifier of the blog tag to retrieve (required).

Output

The node outputs a JSON object representing the blog tag details retrieved from the Lectful API. The structure typically includes fields such as:

  • id: The tag's unique identifier.
  • name: The name of the blog tag.
  • Other metadata related to the tag as provided by the Lectful API.

The output is accessible under the json property of the node's output data. There is no binary data output for 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 configuration of the base URL and API key within the node parameters.
  • The API key must have sufficient permissions to perform administrative blog tag queries.

Troubleshooting

  • Missing or invalid credentials:
    Error thrown if neither valid stored credentials nor manual configuration with base URL and API key are provided.
    Resolution: Configure credentials properly or use manual mode with correct values.

  • Missing Tag ID:
    The operation requires a Tag ID parameter; omitting it will cause an error.
    Resolution: Provide a valid Tag ID.

  • API errors (e.g., 404 Not Found):
    If the specified Tag ID does not exist or the API key lacks permission, the API may return an error.
    Resolution: Verify the Tag ID exists and the API key has admin rights.

  • Network or connectivity issues:
    Failure to reach the Lectful API endpoint will cause request errors.
    Resolution: Check network connectivity and base URL correctness.


Links and References


Summary

This node's "Get Tag (Admin)" operation provides a straightforward way to retrieve detailed information about a specific blog tag from the Lectful platform using administrative API endpoints. It supports flexible authentication modes and outputs the tag data as JSON for further processing in n8n workflows.

Discussion