Getting Started

Get up and running with our URL shortener API in just a few simple steps:

• Generate your API key in Edit Profile → API Keys
• Send your key on every request using both headers:
  Authorization: Bearer YOUR_API_KEY
  X-API-Key: YOUR_API_KEY
• Use JSON for POST requests (Content-Type: application/json)
• Start by creating a short URL via /backend/api/common/urls/create.php

Create your first shortened URL:

• Endpoint: POST /backend/api/common/urls/create.php
• Headers:
  Authorization: Bearer YOUR_API_KEY
  X-API-Key: YOUR_API_KEY
  Content-Type: application/json
• Body (minimum): { "long_url": "https://example.com" }
• Optional fields: custom_slug, expiration_type (clicks|date), expiration_value, utm_source, utm_medium, utm_campaign, target_type (include|exclude|all), countries ("US,GB"), redirect_url, tracking_pixels (object), link_space

curl -X POST "{BASE_URL}backend/api/common/urls/create.php" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "long_url": "https://example.com",
  "custom_slug": "launch",
  "utm_source": "google",
  "tracking_pixels": {"google": "G-XXXXXX"}
}'

Understanding your API management tools:

• API Tester: Test all endpoints with built-in interface
• URL Management: Create, read, update, delete URLs via API
• Spaces Management: Organize URLs into spaces
• Domains Management: Manage custom domains
• Pixels Management: Set up tracking pixels
• Analytics: Get comprehensive statistics via API
• AI Features: Access AI-powered optimization tools

Essential API terminology and concepts to know:

• API Key: Required on every request (Authorization + X-API-Key)
• Rate Limiting: Per‑minute per key; returns 429 when exceeded
• Pagination: limit (1–100) and offset
• Sorting: sort_by and sort_order
• Filtering: search and feature-specific filters
• Spaces: Organizational containers for URLs
• Custom Domains: Branded domains for short links
• Tracking Pixels: Analytics tracking codes