Shlink

Interact with Shlink URL Shortener API

Actions12

Short URL Actions
Tag Actions
Visit Actions
Domain Actions
- Get Many

Overview

This node integrates with the Shlink URL Shortener API to create short URLs from long URLs. It is useful in scenarios where you want to generate concise, shareable links that redirect to longer web addresses. For example, marketing campaigns often use short URLs to track clicks and improve user experience by providing easy-to-share links.

The "Create" operation under the "Short URL" resource allows users to input a long URL and optionally customize the short URL with additional parameters such as custom slugs, tags, validity periods, and visit limits.

Properties

Name	Meaning
Long URL	The original long URL that you want to shorten.
Additional Fields	Optional extra settings for the short URL:
- Custom Slug	A custom string to be used as the short code instead of an auto-generated one.
- Domain	The domain name to which the short URL will be attached.
- Tags	Comma-separated list of tags to categorize or label the short URL.
- Title	A descriptive title for the short URL.
- Find If Exists	Whether to return an existing short URL if it already exists for the given long URL (boolean).
- Max Visits	Maximum number of allowed visits for the short URL; 0 means unlimited.
- Valid Since	Date/time from which the short URL becomes valid.
- Valid Until	Date/time until which the short URL remains valid.

Output

The node outputs JSON data representing the created short URL object returned by the Shlink API. This typically includes details such as:

The generated short code.
The full short URL.
The original long URL.
Metadata like tags, title, visit counts, validity dates, and max visits.
Other relevant information about the short URL's configuration and status.

No binary data output is produced by this operation.

Dependencies

Requires an API key credential for authenticating with the Shlink URL Shortener API.
The base URL of the Shlink instance must be configured in the credentials.
The node makes HTTP requests to the Shlink REST API endpoints.

Troubleshooting

Invalid Base URL: If the base URL does not start with http:// or https://, the node automatically prepends https://. Ensure your base URL is correct and accessible.
API Request Failures: Errors during HTTP requests may occur due to network issues, invalid credentials, or incorrect parameters. Error messages include HTTP status codes and response data when available.
Custom Slug Conflicts: If a custom slug is already taken and Find If Exists is false, the API may return an error. Enable Find If Exists to retrieve existing short URLs instead of creating duplicates.
Date Format Issues: Ensure that Valid Since and Valid Until fields are provided in proper date-time format supported by the API.
Max Visits Zero Behavior: Setting Max Visits to zero means unlimited visits; setting a positive number restricts access after that many visits.