پایانه توسعه‌دهندگان URLT REST API

مستندات یکپارچه‌سازی API و وب‌هوک‌ها

سرویس‌های سازمانی خود را با چند خط کد به زیرساخت کوتاه‌سازی، وب‌هوک‌های امنیتی و آمار URLT متصل کنید.

احراز هویت با API Key

تمامی درخواست‌ها به اندپوینت‌های اختصاصی باید شامل هدر X-API-Key باشند. کلیدهای خود را می‌توانید در بخش کلیدهای API در داشبورد ایجاد و مدیریت کنید.

نمونه درخواست ساخت لینک کوتاه (POST /links)

curl -X POST https://urlt.ir/api/v1/links \
  -H "Content-Type: application/json" \
  -H "X-API-Key: urlt_live_9f83a8f27e61..." \
  -d '{
    "destinationUrl": "https://mybrand.ir/campaign/spring-sale",
    "customSlug": "spring26",
    "title": "Spring Campaign",
    "tags": ["spring", "sale"]
  }'

اندپوینت‌های کلیدی REST

POST/api/v1/links

ایجاد لینک کوتاه اختصاصی همراه با اسلاگ دلخواه، تعیین رمز عبور، پوشه کمپین، تگ‌ها و مقاصد تست A/B.

GET/api/v1/links

دریافت لیست لینک‌های ایجادشده در فضای کاری با امکان فیلتر بر اساس folderId و tag.

GET/api/v1/analytics/:linkId

استعلام آمار کلیک‌ها، توزیع سیستم‌عامل، مرورگرها، ارجاع‌دهندگان و موقعیت جغرافیایی بازدیدکنندگان.

WEBHOOKHMAC-SHA256 Signed Events

ارسال آنی رویدادهای link.clicked و payment.completed به سرور شما با امضای امنیتی در هدر X-URLT-Signature.

سقف درخواست مجاز (Rate Limits)

پلن و سطح دسترسیسقف درخواست در دقیقهشناسه مانیتورینگ
پلن رایگان (Free)60 req/minWorkspace / API Key
پلن کریتور (Creator)240 req/minWorkspace / API Key
پلن بیزینس (Pro)1,000 req/minWorkspace / API Key
پلن سازمانی (Enterprise)5,000 req/minDedicated pool