مستندات API

صفحه اصلی آمار لینک‌ها

مستندات API کوتاه‌کننده لینک clikr

API های clikr به شما امکان می‌دهند تا به صورت برنامه‌نویسی از سرویس کوتاه‌کننده لینک استفاده کنید. با استفاده از این API‌ها می‌توانید لینک‌های کوتاه ایجاد کنید، اطلاعات آن‌ها را دریافت کنید و آمار کلیک‌ها را بررسی کنید.

آدرس پایه API

http://clikr.ir/api/

کوتاه کردن لینک

POST /api/shorten

با استفاده از این API می‌توانید یک لینک بلند را به یک لینک کوتاه تبدیل کنید.

پارامترهای درخواست:

پارامتر نوع توضیحات اجباری
url string لینک اصلی که می‌خواهید کوتاه کنید بله
max_clicks integer حداکثر تعداد کلیک مجاز (اختیاری) خیر

مثال درخواست:

curl -X POST "http://clikr.ir/api/shorten" \
     -H "Content-Type: application/json" \
     -d '{"url": "https://example.com/your-very-long-url-that-needs-shortening", "max_clicks": 100}'

مثال پاسخ:

{
  "url": "https://example.com/your-very-long-url-that-needs-shortening",
  "short_code": "Ab3X9z",
  "clicks": 0
}

دریافت اطلاعات لینک کوتاه

GET /api/info/{short_code}

با استفاده از این API می‌توانید اطلاعات یک لینک کوتاه را دریافت کنید.

پارامترهای مسیر:

پارامتر نوع توضیحات
short_code string کد کوتاه لینک

مثال درخواست:

curl "http://clikr.ir/api/info/Ab3X9z"

مثال پاسخ:

{
  "url": "https://example.com/your-very-long-url-that-needs-shortening",
  "short_code": "Ab3X9z",
  "clicks": 5
}

نمونه کد در زبان‌های مختلف

کوتاه کردن لینک با JavaScript:

// با استفاده از Fetch API
async function shortenUrl(url, maxClicks = null) {
  const response = await fetch('http://clikr.ir/api/shorten', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      url: url,
      max_clicks: maxClicks
    })
  });

  const data = await response.json();
  return data;
}

// استفاده از تابع
shortenUrl('https://example.com/long-url', 100)
  .then(result => console.log(result))
  .catch(error => console.error('Error:', error));

کوتاه کردن لینک با Python:

import requests
import json

def shorten_url(url, max_clicks=None):
    api_url = 'http://clikr.ir/api/shorten'
    payload = {'url': url}

    if max_clicks is not None:
        payload['max_clicks'] = max_clicks

    headers = {'Content-Type': 'application/json'}

    response = requests.post(api_url, data=json.dumps(payload), headers=headers)

    if response.status_code == 200:
        return response.json()
    else:
        raise Exception(f"Error: {response.status_code}, {response.text}")

# استفاده از تابع
try:
    result = shorten_url('https://example.com/long-url', max_clicks=100)
    print(result)
except Exception as e:
    print(e)

دریافت اطلاعات لینک با cURL:

curl "http://clikr.ir/api/info/Ab3X9z" | jq

کدهای پاسخ

کد توضیحات
200 درخواست با موفقیت انجام شد
400 درخواست نامعتبر (مثلاً URL نامعتبر)
404 لینک کوتاه یافت نشد
500 خطای داخلی سرور