Developer Documentation

Complete beginner-friendly guide to integrating EdgeLink into your applications

👋 Welcome to EdgeLink API

EdgeLink provides a simple, fast, and powerful REST API for URL shortening. This guide will help you get started in minutes, even if you're new to APIs.

⚡ Fast & Global

<50ms response time on Cloudflare Edge

🔒 Secure

JWT authentication & HTTPS only

📊 Feature-Rich

Analytics, routing, QR codes & more

1

Create Your Account

First, you'll need an EdgeLink account. Sign up for free to get started.

Free Plan Includes:

  • • 1,000 total active links
  • • 10,000 clicks per month
  • • 100 API calls per day
  • • Basic features included
Sign Up For Free →
2

Get Your API Token

After signing up, you'll need to authenticate to get your JWT token.

Option A: Login via API

curl -X POST https://go.shortedbro.xyz/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "your-email@example.com",
    "password": "your-password"
  }'

# Response:
{
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "refresh_token": "eyJhbGciOiJIUzI1NiIs...",
  "expires_in": 86400,
  "user": {
    "user_id": "usr_123",
    "email": "your-email@example.com",
    "plan": "free"
  }
}

Option B: Use Dashboard

You can also get your token from the dashboard after logging in.

3

Make Your First API Call

Let's create your first short link! Replace YOUR_TOKEN with your actual JWT token.

curl -X POST https://go.shortedbro.xyz/api/shorten \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "url": "https://www.example.com/very-long-url-here",
    "custom_slug": "my-link"
  }'

# Response:
{
  "slug": "my-link",
  "short_url": "https://go.shortedbro.xyz/my-link",
  "expires_in": null
}

🎉 You're All Set!

Congratulations! You've created your first short link. Here's what you can explore next:

📚 API Reference

Explore all available endpoints and features

🪝 Webhooks

Get real-time notifications for events

💡 Use Cases

See real-world examples and implementations

⚡ Upgrade to Pro

100K links, 500K clicks/month, advanced features

View Pricing →

🔧 Troubleshooting

401 Unauthorized Error

Make sure your JWT token is valid and included in the Authorization header: Authorization: Bearer YOUR_TOKEN

429 Rate Limit Exceeded

You've hit your daily API limit (100/day free, 5,000/day pro). Wait for the limit to reset or upgrade to Pro.

409 Conflict - Slug Already Exists

The custom slug you chose is already taken. Try a different slug or let EdgeLink generate one automatically by omitting the custom_slug field.

403 Forbidden - Feature Not Available

You're trying to use a Pro feature (custom domains, QR codes, routing, etc.). Upgrade to Pro to access all features.

Need Help?

Sign up now to start building with EdgeLink.