Developer API v1

مستندات REST API

تمام قابلیت‌های سرویس از طریق API در دسترس است. احراز هویت با هدر Authorization: Bearer API_KEY یا X-API-Key انجام می‌شود.

آدرس پایه
https://insl.ir/wp-json/ins-link/v1
متدمسیرتوضیح
POST/shortenساخت لینک کوتاه جدید
GET/linksفهرست لینک‌های کاربر
GET/links/{id}جزئیات یک لینک
PUT/links/{id}ویرایش لینک
DELETE/links/{id}حذف لینک
GET/analytics/{id}آمار کامل یک لینک
GET/bioفهرست صفحات بایو
POST/bioساخت صفحه بایو
PUT/bio/{id}ویرایش صفحه بایو
GET/accountاطلاعات حساب، پلن و مصرف
GET/plansلیست پلن‌ها (عمومی)
نمونه درخواست
curl -X POST https://insl.ir/wp-json/ins-link/v1/shorten \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"url":"https://example.com/page","slug":"my-link","title":"کمپین"}'
نمونه پاسخ
{
  "success": true,
  "data": {
    "id": 12,
    "slug": "my-link",
    "short_url": "https://insl.ir/my-link",
    "target_url": "https://example.com/page",
    "clicks": 0
  }
}

محدودیت نرخ: ۱۲۰ درخواست در دقیقه برای هر کلید. خطاها با کد وضعیت استاندارد HTTP و پیام فارسی بازگردانده می‌شوند.