راهنمای توسعه‌دهندگان

مستندات فنی رابط برنامه‌نویسی f2n.ir

سرویس f2n.ir امکان ساخت و هدایت پیوندها با پیشوند برند شما را از طریق وب‌سرویس RESTful فوق‌سریع در کمترین زمان ممکن فراهم می‌کند.

شیوه احراز هویت (Authentication)

تمام درخواست‌های API نیازمند ارسال کلید اختصاصی شما هستند. کلید API خود را می‌توانید پس از ورود در پنل کاربری f2n.ir دریافت نمایید. کلید را به یکی از دو روش زیر ارسال کنید:

# روش اول: استفاده از هدر اختصاصی
X-API-Key: f2n_live_your_secret_api_key

# روش دوم: هدر استاندارد Bearer
Authorization: Bearer f2n_live_your_secret_api_key

کوتاه‌سازی و تولید پیوند جدید

POST https://f2n.ir/api/v1/links/shorten

اگر برای حساب خود پیشوند اختصاصی (مانند mb) ثبت کرده باشید، تمام پیوندها به شکل خودکار با الگوی f2n.ir/mb-slug صادر می‌گردند.

پارامتر نوع وضعیت توضیحات
url String اجباری نشانی اینترنتی مقصد (باید با http:// یا https:// آغاز شود)
custom_code String اختیاری شناسه دلخواه (مانند rick که نتیجه آن mb-rick خواهد بود)
password String اختیاری رمز عبور پیوند جهت محافظت از دسترسی به آدرس مقصد
title String اختیاری برچسب پیوند جهت دسته‌بندی و شناسایی در پنل مدیریت

نمونه کدهای پیاده‌سازی

curl -X POST https://f2n.ir/api/v1/links/shorten \
  -H "X-API-Key: f2n_live_your_secret_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/target-page",
    "custom_code": "campaign",
    "title": "کمپین نوروزی"
  }'

نمونه پاسخ موفق (200 OK)

{
  "success": true,
  "data": {
    "code": "mb-campaign",
    "short_url": "https://f2n.ir/mb-campaign",
    "original_url": "https://example.com/target-page",
    "title": "کمپین نوروزی",
    "prefix": "mb"
  }
}