API URL Shortener: Integrate Link Shortening into Your Workflow

An API URL shortener gives developers programmatic control over link creation, management, and analytics. Instead of logging into a web dashboard to create links one at a time, you can shorten thousands of URLs with a single script, integrate shortening into your own applications, and pull analytics data directly into your reporting systems. This guide covers everything you need to integrate RELURL's API URL shortener into your development workflow, with working code examples in curl, Python, and JavaScript.

Why Use an API URL Shortener?

• Bulk link creation: Generate hundreds or thousands of short links in seconds using a script, ideal for product catalogs, email campaigns, or redirect migrations.
• Automated workflows: Trigger link creation from CI/CD pipelines, form submissions, or e-commerce order confirmations without manual intervention.
• Custom integrations: Embed shortening directly into your CMS, social media scheduler, or analytics dashboard so your team never leaves your primary tool.
• Real-time data access: Pull click analytics, referrer data, and geographic breakdowns into your own dashboards and reporting tools via API.

Authentication and Getting Started

Every request to the RELURL API requires authentication via an API key. You generate API keys from your RELURL dashboard under Settings > API Keys. Each key has configurable permissions read-only, full access, or scoped to specific workspaces. Store your API key securely. Treat it like a password. Never commit it to version control or expose it in client-side code.

The base URL for all API requests is https://api.relurl.com/v1. All requests must include your API key in the Authorization header as a Bearer token. Responses are returned in JSON format. The API uses standard HTTP response codes to indicate success, errors, and rate limits.

Core Endpoints Overview

The RELURL API URL shortener exposes several endpoints. POST /links creates a new short link. GET /links lists all your links with pagination. GET /links/:id retrieves a specific link with full analytics. PATCH /links/:id updates a links destination, slug, or settings. DELETE /links/:id removes a link permanently. POST /links/:id/expire sets an expiration date on a link.

Each endpoint accepts and returns structured JSON. The API documentation at docs.relurl.com lists every available parameter, response field, and error code with examples.

Creating a Short Link with curl

Using curl, you can test the API URL shortener directly from your terminal. The following command creates a short link with a custom alias and UTM parameters appended to the destination.

The API responds with the newly created link object, including the short URL, the destination, the slug, and timestamps. The response also includes a unique link ID that you use for subsequent operations like updating or deleting the link.

Creating Links with Python

In Python, the requests library makes API URL shortener integration straightforward. Here is a function that creates a short link and returns the result.

This pattern extends easily to bulk operations. Loop through a list of destinations, call the function for each one, and collect the results. Add error handling and backoff logic to handle rate limits gracefully in production code.

JavaScript and Node.js Integration

For Node.js applications, the fetch API or axios handles API URL shortener requests cleanly. Here is an async function that creates a link and returns analytics-ready data.

This approach works in serverless functions, backend services, and automation scripts. For frontend applications, always proxy API requests through your backend to keep your API key secret.

Rate Limits and Error Handling

The RELURL API URL shortener enforces rate limits to ensure platform stability. Free tier accounts are limited to 100 requests per minute. Paid plans offer higher limits up to 10,000 requests per minute. When you exceed the rate limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating the number of seconds to wait.

Implement exponential backoff in your integration. On receiving a 429, wait the number of seconds specified in Retry-After, then retry. If the request succeeds, gradually reduce the delay. This pattern prevents hammering the API during rate limits and ensures your integration remains stable under load.

Webhook Integration for Event-Driven Workflows

Beyond the request-response API, RELURL supports webhooks that notify your server when events occur. Configure webhook URLs in your dashboard, and RELURL sends POST requests to your endpoint with JSON payloads when links are clicked, created, or updated. This enables event-driven architectures where your application reacts to link activity in real time without polling.

Combine the API URL shortener with webhooks for powerful automation. Create a link via the API, receive click notifications via webhook, and trigger downstream actions like updating a CRM record, sending a Slack alert, or adjusting an ad budget.