Clizme API

Introduction

The Clizme API lets authenticated users shorten URLs via HTTPS. All requests and responses are JSON. No SDK required — use any HTTP client.

Authentication

Use Bearer token with your API key. Create keys at /dev-api.

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Keys are shown only once — store securely. Never expose in client-side JS.

Create Shortlink

POST https://clizme.fun/api/v1/shorten

Request Body

{
  "url": "https://example.com",
  "alias": "my-campaign" // optional, 3-30 chars
}

cURL Example

curl -X POST https://clizme.fun/api/v1/shorten \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","alias":"my-campaign"}'

Success Response 200

{
  "success": true,
  "short_url": "https://clizme.fun/X7KP92",
  "code": "X7KP92",
  "existing": false
}

If destination already exists for your account, existing:true and the existing short_url is returned.

Error Response

{
  "success": false,
  "error": "Invalid URL"
}

HTTP Status Codes

Rate Limits

60 requests / minute per API key. Exceeding returns 429 with Retry-After header.

Parameters

alias: 3-30 chars, A-Z a-z 0-9 _ -, not reserved.

Response Fields

• success bool
• short_url string — full URL
• code string — alias or 6-char code
• existing bool — true if destination already existed
• error string — on failure

Tips

• Store API key server-side, never in browser JS
• Custom alias lets you brand links: clizme.fun/my-brand
• Same destination returns existing link — idempotent