لیست پیوند ها

آدرس درخواست :

GET
https://zaya.io/api/v1/links

مثال ها :

# CURL Example:
curl --location --request GET 'https://zaya.io/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
# PHP Example:
$params = [];
$url = "https://zaya.io/api/v1/links";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Authorization: Bearer {api_key}'
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);
$result = json_decode($result, true);

پاسخ ها :

200

{
    "data": [
        {...}
    ],
    "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
    },
    "meta": {
        "current_page": 0,
        "from": 0,
        "last_page": 0,
        "links": [
            {pagination}
        ],
        "path": "string",
        "per_page": 0,
        "to": 0,
        "total": 0
    }
}
403412

{
    "message": "string",
    "status": INT
}

پارامتر ها :

نام
نوع
توضیحات
search
اختیاری string
با استفاده از این پارامتر می توانید پیوند مورد نظر خود را پیدا کنید.
by
اختیاری string

مشخص کنید براساس کدام مقدار می خواهید جستجو کنید:

نکته: درصورتی که این پارامتر را ارسال نکنید جستجو برای تمام فیلد ها انجام می‌شود.

title برای عنوان

alias برای پیوند کوتاه

url برای نشانی

status
اختیاری integer

شما می توانید پیوند ها را براساس وضعیتشان فیلتر کنید.

0 یا عدم ارسال برای همه

1 برای فعال

2 برای بررسی نشده

3 برای غیرفعال

4 برای مسدود شده

5 برای منقضی شده

space
اختیاری integer

شما می توانید پیوند های خود را براساس موضوع فیلتر کنید.

نکته: درصورتی که این پارامتر را ارسال نکنید تمامی پیوند ها نمایش داده می شوند.

نکته: دقت داشته باشید که مقدار این پارامتر باید دقیقا ID یک موضوع مشخص باشد.

شما می توانید از قسمت موضوعات لیست و ID آنها را مشاهده کنید.

domain
اختیاری integer

شما می توانید پیوند های خود را براساس دامنه نیز فیلتر کنید.

نکته: درصورتی که این پارامتر را ارسال نکنید تمامی پیوند ها نمایش داده می شوند.

نکته: دقت داشته باشید که مقدار این پارامتر باید دقیقا ID یک دامنه مشخص باشد.

شما می توانید از قسمت دامنه ها لیست و ID آنها را مشاهده کنید.

favorites
اختیاری integer

با ارسال 1 به عنوان مقدار این پارامتر می توانید لینک های مورد علاقه خود را دریافت کنید.

sort
اختیاری string

شما می توانید نتایج را بصورت دلخواه مرتب کنید.

desc یا عدم ارسال برای جدیدترین ها

asc برای قدیمی ترین ها

max برای بیشترین کلیک

min برای کمترین کلیک

ساخت پیوند

آدرس درخواست :

POST
https://zaya.io/api/v1/links

مثال ها :

# CURL Example:
curl --location --request POST 'https://zaya.io/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
# PHP Example:
$url = "https://zaya.io/api/v1/links";
$params = ['url' => '{url}'];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Authorization: Bearer {api_key}'
]);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);
$result = json_decode($result, true);

پاسخ ها :

200

{
    "data": [
        {...}
    ],
    "status": 200
}
403412

{
    "message": "string",
    "status": INT
}
422

{
    "message": {
        "param": [
            "string"
        ]
    },
    "status": INT
}

پارامتر ها :

نام
نوع
توضیحات
url
ضروری string
پیوندی که قصد دارید کوتاه شود.
alias
اختیاری string
پیوند یکتا دلخواه.
password
اختیاری string
رمز عبور پیوند.
space
اختیاری integer

شما می توانید موضوع دلخواه خود را برای پیوند کوتاه تنظیم کنید.

نکته: دقت داشته باشید که مقدار این پارامتر باید دقیقا ID یک موضوع مشخص باشد.

شما می توانید از قسمت موضوعات لیست و ID آنها را مشاهده کنید.

domain
اختیاری integer

شما می توانید دامنه دلخواه خود را برای پیوند کوتاه تنظیم کنید.

نکته: دقت داشته باشید که مقدار این پارامتر باید دقیقا ID یک دامنه مشخص باشد.

شما می توانید از قسمت دامنه ها لیست و ID آنها را مشاهده کنید.

disabled
اختیاری integer

برای غیرفعال کردن پیوند کوتاه مقدار این پارامتر را 1 قرار دهید.

نکته: بصورت پیشفرض پیوند فعال می باشد.

public
اختیاری integer

برای عمومی کردن آمار پیوند مقدار این پارامتر را 1 قرار دهید.

نکته: بصورت پیشفرض آمار پیوند خصوصی می باشد

description
اختیاری string
شما می توانید توضیح مختصری برای پیوند خود وارد کنید. MAX: 127 characters
expiration_url
اختیاری string
پیوندی که بعد از منقضی شدن پیوند کوتاه، کاربران به آن هدایت می شوند.
expiration_date
اختیاری string

تاریخ انقضاء لینک در فرمت YYYY-MM-DD .

نکته: تاریخ را به میلادی وارد کنید.

expiration_time
اختیاری string
زمان انقضاء لینک در فرمت HH:MM .
expiration_clicks
اختیاری integer
تعداد کلیک هایی که پس از آن باید پیوند کوتاه منقضی شود.
target_type
اختیاری integer

با استفاده از این پارامتر می توانید نوع هدف گیری را مشخص کنید.

نکته: عدم ارسال یا مقدار 0 به معنی غیرفعال بودن هدف گیری می باشد.

1 برای جغرافیایی

2 برای انتخاب پلتفرم

3 برای چرخش لینک

geo[index][key],
geo[index][value]
اختیاری string

برای هدف گیری جغرافیایی، کد کشور را باید با کلید key ارسال کنید.

و آدرس URL مورد نظر را باید با کلید value ارسال کنید.

نکته: کد کشور انتخابی می بایست با استاندارد ISO 3166-1 alpha-2 وارد شود.

نکته: پارامتر ارسالی باید یک آرایه باشد و مقدایر باید بصورتی که اشاره شد جایگذاری شوند.

platform[index][key],
platform[index][value]
اختیاری string

برای هدف گیری پلتفرم، نام پلتفرم مورد نظر را باید با کلید key ارسال کنید.

و آدرس URL مورد نظر را باید با کلید value ارسال کنید.

نکته: مقادیر قابل استفاده: Ubuntu, Linux, OS X, Windows, Android, iOS, Chrome OS

نکته: پارامتر ارسالی باید یک آرایه باشد و مقدایر باید بصورتی که اشاره شد جایگذاری شوند.

rotation[index][value]
اختیاری string

با استفاده از این قابلیت شما می توانید برای هرکلیک به صورت چرخشی کاربر را به پیوند متفاوتی منتقل کنید.

نکته: آدرس URL مورد نظر را باید با کلید value ارسال کنید.

نکته: پارامتر ارسالی باید یک آرایه باشد و مقدایر باید بصورتی که اشاره شد جایگذاری شوند.

جزییات پیوند

آدرس درخواست :

GET
https://zaya.io/api/v1/links/{id}

مثال ها :

# CURL Example:
curl --location --request GET 'https://zaya.io/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
# PHP Example:
$url = "https://zaya.io/api/v1/links/{id}";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Authorization: Bearer {api_key}'
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);
$result = json_decode($result, true);

پاسخ ها :

200

{
    "data": [
        {...}
    ],
    "status": 200
}
403412404

{
    "message": "string",
    "status": INT
}

بروزرسانی پیوند

آدرس درخواست :

PUT PATCH
https://zaya.io/api/v1/links/{id}

مثال ها :

# CURL Example:
curl --location --request PUT 'https://zaya.io/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
# PHP Example:
$params = ['url' => '{url}'];
$url = https://zaya.io/api/v1/links/{id};

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Authorization: Bearer {api_key}'
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);
$result = json_decode($result, true);

پاسخ ها :

200

{
    "data": [
        {...}
    ],
    "status": 200
}
403412404

{
    "message": "string",
    "status": INT
}
422

{
    "message": {
        "param": [
            "string"
        ]
    },
    "status": INT
}

پارامتر ها :

نام
نوع
توضیحات
url
اختیاری string
پیوندی که قصد دارید کوتاه شود.
alias
اختیاری string
پیوند یکتا دلخواه.
password
اختیاری string
رمز عبور پیوند.
space
اختیاری integer

شما می توانید موضوع دلخواه خود را برای پیوند کوتاه تنظیم کنید.

نکته: دقت داشته باشید که مقدار این پارامتر باید دقیقا ID یک موضوع مشخص باشد.

شما می توانید از قسمت موضوعات لیست و ID آنها را مشاهده کنید.

domain
اختیاری integer

شما می توانید دامنه دلخواه خود را برای پیوند کوتاه تنظیم کنید.

نکته: دقت داشته باشید که مقدار این پارامتر باید دقیقا ID یک دامنه مشخص باشد.

شما می توانید از قسمت دامنه ها لیست و ID آنها را مشاهده کنید.

disabled
اختیاری integer

برای غیرفعال کردن پیوند کوتاه مقدار این پارامتر را 1 قرار دهید.

نکته: بصورت پیشفرض پیوند فعال می باشد.

public
اختیاری integer

برای عمومی کردن آمار پیوند مقدار این پارامتر را 1 قرار دهید.

نکته: بصورت پیشفرض آمار پیوند خصوصی می باشد

description
اختیاری string
شما می توانید توضیح مختصری برای پیوند خود وارد کنید. MAX: 127 characters
expiration_url
اختیاری string
پیوندی که بعد از منقضی شدن پیوند کوتاه، کاربران به آن هدایت می شوند.
expiration_date
اختیاری string

تاریخ انقضاء لینک در فرمت YYYY-MM-DD .

نکته: تاریخ را به میلادی وارد کنید.

expiration_time
اختیاری string
زمان انقضاء لینک در فرمت HH:MM .
expiration_clicks
اختیاری integer
تعداد کلیک هایی که پس از آن باید پیوند کوتاه منقضی شود.
target_type
اختیاری integer

با استفاده از این پارامتر می توانید نوع هدف گیری را مشخص کنید.

نکته: عدم ارسال یا مقدار 0 به معنی غیرفعال بودن هدف گیری می باشد.

1 برای جغرافیایی

2 برای انتخاب پلتفرم

3 برای چرخش لینک

geo[index][key],
geo[index][value]
اختیاری string

برای هدف گیری جغرافیایی، کد کشور را باید با کلید key ارسال کنید.

و آدرس URL مورد نظر را باید با کلید value ارسال کنید.

نکته: کد کشور انتخابی می بایست با استاندارد ISO 3166-1 alpha-2 وارد شود.

نکته: پارامتر ارسالی باید یک آرایه باشد و مقدایر باید بصورتی که اشاره شد جایگذاری شوند.

platform[index][key],
platform[index][value]
اختیاری string

برای هدف گیری پلتفرم، نام پلتفرم مورد نظر را باید با کلید key ارسال کنید.

و آدرس URL مورد نظر را باید با کلید value ارسال کنید.

نکته: مقادیر قابل استفاده: Ubuntu, Linux, OS X, Windows, Android, iOS, Chrome OS

نکته: پارامتر ارسالی باید یک آرایه باشد و مقدایر باید بصورتی که اشاره شد جایگذاری شوند.

rotation[index][value]
اختیاری string

با استفاده از این قابلیت شما می توانید برای هرکلیک به صورت چرخشی کاربر را به پیوند متفاوتی منتقل کنید.

نکته: آدرس URL مورد نظر را باید با کلید value ارسال کنید.

نکته: پارامتر ارسالی باید یک آرایه باشد و مقدایر باید بصورتی که اشاره شد جایگذاری شوند.

حذف پیوند

آدرس درخواست :

DELETE
https://zaya.io/api/v1/links/{id}

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

# CURL Example:
curl --location --request DELETE 'https://zaya.io/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'
# PHP Example:
$url = https://zaya.io/api/v1/links/{id};

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Authorization: Bearer {api_key}'
]);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$result = curl_exec($ch);
$result = json_decode($result, true);

پاسخ ها :

200

{
    "id": int,
    "object": "link",
    "deleted": boolean,
    "status": 200
}
403412404

{
    "message": "string",
    "status": INT
}
نظرسنجی

آیا از امکانات زایا راضی هستید؟

خیلی ناراضی
ناراضی
معمولی
راضی
خیلی راضی

زایا همیشه در حال ارتقا سیستم و اضافه کردن امکانات کاربردی می باشد. نظرات شما باعت پیشرفت سیستم خواهد شد.