BCL icon

BCL

Consume BCL Payment API

Overview

This node integrates with the BCL Payment API to manage various resources such as payment links, forms, and coupons. Specifically for the Form resource and the Update Title operation, it allows users to update the title of an existing form by specifying the form ID and the new title.

This node is beneficial in scenarios where you need to programmatically update form metadata without manually accessing the BCL dashboard. For example, you might want to rename a form dynamically based on external events or user input within an automated workflow.

Practical example:

  • Automatically update the title of a registration form when a new event is created.
  • Rename promotional forms based on marketing campaigns triggered in other systems.

Properties

Name Meaning
Form ID The unique numeric identifier of the form to update. Required.
Title The new title string to set for the form. Required.

Output

The node outputs JSON data representing the updated form object returned from the BCL API after the title change. This typically includes the form's details such as its ID, updated title, and other metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an API token credential for authenticating with the BCL Payment API.
  • The node makes HTTP requests to the BCL API endpoint at https://bcl.my/api.
  • Proper configuration of the API token credential in n8n is necessary for successful execution.

Troubleshooting

Common Issues

  • Authentication failures: If the API token is invalid or expired, the node will return an authentication error.
  • Validation errors: Missing required parameters like formId or title, or providing invalid values, will cause validation errors.
  • Not found errors: Specifying a non-existent form ID will result in a "not found" error.
  • Permission errors: Insufficient permissions for the API token can cause forbidden access errors.
  • Server errors: Temporary issues on the BCL server side may cause 5xx errors.

Error Messages and Resolutions

  • Authentication failed:
    Message: "Authentication failed: Invalid or expired API token."
    Resolution: Verify and update the API token credential in n8n.

  • Validation error:
    Message: "Validation error: The API could not process your request."
    Resolution: Check that all required fields (formId, title) are provided and valid.

  • Not found:
    Message: "Not found: The requested resource does not exist."
    Resolution: Confirm the formId corresponds to an existing form.

  • Forbidden:
    Message: "Forbidden: You do not have permission to access this resource."
    Resolution: Ensure the API token has sufficient permissions.

  • Bad request:
    Message: "Bad request: The request was improperly formatted or contained invalid parameters."
    Resolution: Review the input parameters for correctness.

  • Server error:
    Message: "Server error: The BCL server encountered an error."
    Resolution: Retry later or contact BCL support if persistent.

Links and References


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

Discussion