Overview
This node integrates with the CodeQR API to create short links (URLs) with various customizable options. It is useful for automating URL shortening workflows, managing link redirection, and enhancing link tracking or presentation. For example, you can generate a branded short link that redirects differently based on device type or geographic location, set expiration dates, add password protection, or attach metadata like titles and descriptions.
Common scenarios include:
- Creating marketing campaign links with custom domains and tags.
- Generating device-specific redirect URLs (iOS, Android).
- Setting up expiring links for limited-time offers.
- Adding password protection to sensitive links.
- Enabling public statistics for shared links.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication; currently supports "Access Token". |
| Long URL | The destination URL that the short link will redirect to. |
| Additional Fields | A collection of optional settings to customize the short link: |
| - Allow Indexing | Boolean flag to enable or disable indexing of the short link by search engines. |
| - Android URL | Device-specific redirect URL for Android devices. |
| - Comments | Notes or comments about the short link. |
| - Description | Text description displayed on the short link's page. |
| - Domain | Custom domain for the short link; if omitted, the workspace default domain is used. |
| - Expiration Date | Date/time when the short link expires and becomes inactive. |
| - Expired Redirect URL | URL to redirect users to after the short link has expired. |
| - External ID | An external identifier for the link in your own database; must be prefixed with ext_. |
| - Flexible Link | Boolean indicating if the link supports dynamic destination changes. |
| - Geo-Targeting | JSON mapping of country codes to specific destination URLs for geographic-based redirection. |
| - Image URL | URL of an image shown on the short link's page. |
| - iOS URL | Device-specific redirect URL for iOS devices. |
| - Key | Custom slug for the short link; if not provided, a random 7-character slug is generated. |
| - Password | Password required to access the destination URL. |
| - Proxy | Boolean to enable proxy settings for the link. |
| - Public Stats | Boolean to make the short link's statistics publicly accessible. |
| - Rewrite Link | Boolean to enable rewriting of the short link. |
| - Tag IDs | Array of tag IDs to associate with the short link. |
| - Tag Names | Array of tag names to associate with the short link. |
| - Title | Title displayed on the short link's page. |
| - Video URL | URL of a video displayed on the short link's page. |
Output
The node outputs a JSON array containing the response from the CodeQR API after creating the short link. This typically includes details such as the generated short link URL, its slug/key, metadata, and any other relevant information returned by the API.
If the API supports binary data output (e.g., QR code images), it is not explicitly handled here, so the output focuses on JSON data describing the created link.
Dependencies
- Requires an API key credential for authenticating with the CodeQR API.
- The node depends on the CodeQR service being available and reachable via network.
- No additional environment variables or external dependencies are indicated beyond the API key.
Troubleshooting
- Unsupported Operation Error: If the specified resource-operation combination is not supported, the node throws an error stating the operation is unsupported. Ensure you select valid Resource ("Link") and Operation ("Create").
- Missing Required Fields: The "Long URL" property is mandatory. Omitting it will likely cause API errors.
- Invalid JSON in Geo-Targeting: The geo-targeting field expects valid JSON mapping country codes to URLs. Malformed JSON may cause failures.
- Authentication Failures: Incorrect or missing API key credentials will prevent successful API calls.
- Expiration Date Format: Ensure the expiration date is in a valid datetime format accepted by the API.
- Slug Conflicts: Providing a custom slug ("Key") that already exists may cause errors; either omit it to auto-generate or ensure uniqueness.
Links and References
- CodeQR Official Website
- CodeQR API Documentation (assumed, check actual docs for details)
- n8n Documentation on Creating Custom Nodes