API Documentation

Getting Started

The EziLinks API allows you to programmatically create, manage, and track short URLs. All API requests require authentication using an API key.

Base URL

https://ezilinks.com/api

Response Format

All responses are returned in JSON format. Successful responses return a 2xx status code, while errors return 4xx or 5xx status codes with an error message.

Authentication

All API requests must include your API key in the request header:

X-API-Key: your_api_key_here

Example Request

curl -X POST https://ezilinks.com/api/urls \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"originalUrl": "https://example.com"}'

Create Short URL

Create a new short URL. Custom aliases and password protection require a Pro plan.

{
  "originalUrl": "https://example.com/very/long/url",
  "title": "My Example Link",
  "description": "This is a test link"
}

{
  "id": 123,
  "shortCode": "abc123",
  "shortUrl": "https://ezilinks.com/abc123",
  "originalUrl": "https://example.com/very/long/url",
  "title": "My Example Link",
  "description": "This is a test link",
  "createdAt": "2024-01-01T12:00:00.000Z"
}

List URLs

Retrieve all short URLs for your account.

[
  {
    "id": 123,
    "shortCode": "abc123",
    "originalUrl": "https://example.com",
    "title": "My Link",
    "clicks": 42,
    "createdAt": "2024-01-01T12:00:00.000Z"
  }
]

Update URL

Update an existing short URL's details.

Delete URL

Delete a short URL permanently.

{
  "message": "URL deleted successfully"
}

Get Analytics

Retrieve detailed analytics for a specific short URL. Requires Pro plan.

{
  "totalClicks": 156,
  "uniqueClicks": 98,
  "clicksByDate": [...],
  "clicksByCountry": [...],
  "clicksByDevice": [...]
}

Generate QR Code

Generate a QR code for a short URL.

Error Codes