Boomerangme icon

Boomerangme

Interact with Boomerangme API

Overview

The "Receive Reward" operation on the "Card" resource in this node interacts with the Boomerangme API to register the receipt of a reward on a specific card. This is typically used in loyalty or rewards programs where customers accumulate points, stamps, or other metrics on their cards and then redeem or receive rewards based on those accumulations.

Common scenarios include:

  • A customer redeems a reward after collecting enough points or stamps.
  • The system logs the event of a reward being granted to a customer's card.
  • Businesses track reward redemptions for analytics or customer engagement purposes.

Practical example: After a customer collects 10 stamps on their loyalty card, this operation can be triggered to mark the reward as received, optionally adding a comment about the transaction.

Properties

Name Meaning
Card ID The unique identifier of the card on which the reward is being received. (string)
Comment An optional text comment related to receiving the reward, such as details or notes.

Output

The node outputs JSON data representing the response from the Boomerangme API after registering the reward receipt on the specified card. This typically includes confirmation details such as updated card status, reward information, timestamps, or any messages returned by the API.

If the API supports binary data output (not indicated here), it would represent associated files or media related to the reward, but this is not evident from the provided code.

Dependencies

  • Requires an active connection to the Boomerangme API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for API requests is https://api.digitalwallet.cards/api/v2.
  • Proper network access to the Boomerangme service endpoint.

Troubleshooting

  • Invalid Card ID: If the card ID is incorrect or does not exist, the API will likely return an error. Verify the card ID before making the request.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key/token is correctly set up in n8n.
  • Network Issues: Connectivity problems to the Boomerangme API endpoint will prevent successful execution.
  • Missing Required Fields: The "Card ID" property is required; omitting it will cause errors.
  • API Rate Limits: Excessive requests might be throttled by the API; handle such errors gracefully.

Links and References

Discussion