Overview
This node integrates with the CodeQR API to retrieve information about short links. Specifically, the "Get" operation under the "Link" resource fetches details of a short link by its unique identifier. This is useful in scenarios where you need to programmatically access metadata or status of a previously created short link, for example, to verify its existence, check analytics, or display link details within an automation workflow.
Practical examples include:
- Automatically retrieving and logging details of a short link after creation.
- Validating that a short link exists before sending it out in communications.
- Fetching link data to update dashboards or reports.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating with the CodeQR API. Currently supports: Access Token |
| Link ID | The unique identifier of the short link to retrieve. Required for the "Get" operation. |
Output
The node outputs a JSON array containing the retrieved short link's data. Each item in the output corresponds to the detailed information of the requested short link, such as its URL, creation date, click statistics, or other metadata provided by the CodeQR API.
If the API supports binary data (e.g., QR code images), this node might also output binary data representing the QR code associated with the link, but this is not explicitly shown in the provided code snippet.
Dependencies
- Requires an active connection to the CodeQR API.
- Needs an API authentication token (access token) configured in the node credentials.
- No additional environment variables or external dependencies are indicated.
Troubleshooting
- Unsupported Operation Error: If the node throws an error stating the operation is not supported, ensure that the "resource" is set to "Link" and the "operation" is set to "Get". Other combinations may not be implemented.
- Missing or Invalid Link ID: The "Link ID" property is required. Omitting it or providing an invalid ID will likely cause the API call to fail.
- Authentication Failures: Ensure the access token credential is correctly configured and has sufficient permissions.
- API Connectivity Issues: Network problems or API downtime can cause failures; verify connectivity and API status.
Links and References
- CodeQR Official API Documentation (Assumed URL, replace with actual if known)
- n8n Documentation on Creating Custom Nodes