مستندات API Key لینک

راهنمای کامل API Key برای کوتاه‌کننده لینک

شروع سریع

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

کلید را از مسیر /profile/api-key بگیرید و در هدر x-api-key ارسال کنید.

این API فقط برای اکانت پرو فعال است.

http

x-api-key: sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
Accept: application/json

Endpoint ها

POST/api/v1/api-key/links

Create Link

Headers:

http

x-api-key: sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

Request Body:

json

{
  "url": "https://example.com/very/long/url",
  "custom_slug": "a1b2c",
  "expires_in": "24h",
  "password": "1234",
  "max_clicks": 100,
  "burn_after_read": false
}

Response (200 OK):

json

{
  "success": true,
  "data": {
    "code": "a1b2c",
    "original_url": "https://example.com/very/long/url",
    "click_count": 0,
    "expires_at": "2026-03-24T18:30:00Z",
    "created_at": "2026-03-22T18:30:00Z"
  }
}

GET/api/v1/api-key/links/{code}

Show Link

Headers:

http

x-api-key: sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Response (200 OK):

json

{
  "success": true,
  "data": {
    "code": "a1b2c",
    "original_url": "https://example.com/very/long/url",
    "click_count": 42,
    "has_password": false,
    "expires_at": null,
    "created_at": "2026-03-22T18:30:00Z"
  }
}

GET/api/v1/api-key/links/{code}/stats

Show Link Statistics

Headers:

http

x-api-key: sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Response (200 OK):

json

{
  "success": true,
  "data": {
    "code": "a1b2c",
    "original_url": "https://example.com/very/long/url",
    "clicks": {
      "total": 120,
      "today": 12,
      "unique": 85
    },
    "chart": [
      { "date": "2026-03-16", "count": 11 },
      { "date": "2026-03-17", "count": 9 },
      { "date": "2026-03-18", "count": 15 },
      { "date": "2026-03-19", "count": 20 },
      { "date": "2026-03-20", "count": 17 },
      { "date": "2026-03-21", "count": 36 },
      { "date": "2026-03-22", "count": 12 }
    ]
  }
}

GET/api/v1/api-key/links

Show Links (Pagination)

Headers:

http

x-api-key: sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Query Parameters:

text

page=1
per_page=10

Response (200 OK):

json

{
  "success": true,
  "data": {
    "items": [
      {
        "code": "a1b2c",
        "original_url": "https://example.com",
        "click_count": 10,
        "has_password": false,
        "expires_at": null,
        "created_at": "2026-03-22T18:30:00Z"
      }
    ],
    "pagination": {
      "current_page": 1,
      "last_page": 3,
      "per_page": 10,
      "total": 21
    }
  }
}

DELETE/api/v1/api-key/links/{code}

Delete Link

Headers:

http

x-api-key: sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Response (200 OK):

json

{
  "success": true,
  "message": "لینک با موفقیت حذف شد."
}

خطاهای رایج

json

{
  "success": false,
  "error": {
    "code": "API_KEY_REQUIRED",
    "message": "ارسال x-api-key الزامی است."
  }
}

json

{
  "success": false,
  "error": {
    "code": "PRO_REQUIRED",
    "message": "استفاده از API Key فقط برای کاربران پرو فعال است."
  }
}