Please Wait...
Generate branded short URLs programmatically.
The Short Link API allows developers to create short URLs programmatically without logging into the SPRL dashboard. It is ideal for websites, mobile applications, CRM systems, ERP software, marketing platforms, automation tools, and custom business applications.
After authenticating your application using a valid API Key, you can send requests to the Short Link API and receive a shortened URL instantly.
Before using the Short Link API, ensure you have:
| Requirement | Description |
|---|---|
| SPRL Account | An active SPRL account. |
| API Credentials | A valid Client ID and Client Key. |
| HTTPS | All API requests must be sent over HTTPS. |
| API Access | The URL Shortener API must be enabled for your account. |
| Step | Action |
|---|---|
| 1 | Authenticate your request using your API credentials. |
| 2 | Submit the destination URL to the Short Link API. |
| 3 | The API validates the request. |
| 4 | A unique short URL is generated. |
| 5 | The API returns the newly created short link. |
Depending on the endpoint and your account features, a request may include one or more of the following:
| Parameter | Description |
|---|---|
| Destination URL | The original URL to shorten. |
| Custom Alias | Optional custom short code, if supported. |
| Custom Domain | Optional branded domain for the generated short link. |
| Tags | Optional labels used for organisation and reporting. |
| Expiration Settings | Optional expiry rules for temporary links. |
A successful response typically includes information about the newly created short link.
| Response Item | Description |
|---|---|
| Short URL | The generated shortened link. |
| Original URL | The destination URL provided in the request. |
| Reference ID | Unique identifier for the created link. |
| Status | Indicates whether the request completed successfully. |
| Issue | Possible Solution |
|---|---|
| Authentication failed | Verify your Client ID and Client Key. |
| Invalid URL | Ensure the destination URL is valid and publicly accessible. |
| Permission denied | Confirm that the URL Shortener API is enabled for your account. |
| Rate limit exceeded | Reduce the request frequency and retry later. |
| Unexpected API response | Review the endpoint documentation and verify the request format. |
Yes. If your account is configured with a custom domain, you can generate branded short URLs using the API.
Yes. The API is designed for automated integrations with websites, applications, and business systems.
Yes. A successful request returns the newly created short link along with other response information.
Yes. However, API credentials should always be stored securely on your server rather than inside the mobile application.
Our support team is always happy to assist you.
We use cookies to improve your experience, analyse traffic, and personalise content. By clicking “Accept”, you consent to the use of cookies as described in our Cookie Policy .
Accept cookies Read our Cookie Policy
