Lectful icon

Lectful

Interact with the VIPay Lectful API

Authentication → Register

AI-generated

Overview

The "Lectful" node integrates with the VIPay Lectful API, enabling automation of various educational platform tasks such as user authentication, course management, lecture handling, enrollments, and more. Specifically, the Authentication - Register operation allows you to register a new user account by providing personal details and credentials.

This operation is useful in scenarios where you want to automate user onboarding workflows, for example:

  • Automatically registering users who sign up through external forms or other systems.
  • Integrating user registration into multi-step automation pipelines.
  • Syncing user accounts from other platforms into Lectful.

Practical Example

You can use this node to create a workflow that registers new users by collecting their first name, last name, email, and password, then calling the Lectful API to create their account without manual intervention.


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
Email User email address (required)
Password User password (required)
First Name User first name (required)
Last Name User last name (required)
Password Confirmation Password confirmation (required)

Output

The node outputs the JSON response returned by the Lectful API after attempting to register the user. This typically includes information about the newly created user account or error details if registration failed.

The output structure is:

{
  "json": {
    // API response data, e.g.:
    "id": "user_id",
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    // ...additional fields depending on API response
  }
}

No binary data is produced by this operation.


Dependencies

  • Requires access to the Lectful API endpoint.
  • 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 permissions to register new users.

Troubleshooting

Common Issues

  • 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.
  • Base URL or API key not provided in manual mode: Both must be supplied when using manual configuration.
  • Password confirmation mismatch: The API may reject registration if password and password_confirmation do not match.
  • Email already registered: Attempting to register an existing email will result in an API error.

Error Messages and Resolutions

  • "Base URL Override is required when using Manual Configuration mode"
    Ensure you provide a valid base URL when manual mode is selected.

  • "API Key Override is required when using Manual Configuration mode"
    Provide a valid API key in manual mode.

  • "Valid credentials are required when using 'Use Stored Credentials' mode"
    Configure your Lectful API credentials properly in n8n or switch to manual mode.

  • API errors related to user registration (e.g., duplicate email, validation errors) will be returned in the JSON response; review these messages to correct input data.


Links and References


If you need summaries for other operations or resources, feel free to ask!

Discussion