API توسعه دهندگان

شروع کنید احراز هویت محدودیت تعداد درخواست مدیریت پاسخ

شروع کنید

همیشه یک کلید API برای پردازش درخواست‌ها توسط سیستم مورد نیاز است. پس از ثبت نام کاربر، یک کلید API به طور خودکار برای او ایجاد می شود. که باید با هر درخواست ارسال شود (نمونه روبرو را ببینید). اگر کلید API ارسال نشود یا منقضی شده باشد، خطایی رخ می دهد. لطفاً برای جلوگیری از سوء استفاده، کلید API خود را مخفی نگه دارید.

احراز هویت

برای احراز هویت با سیستم API، باید با هر درخواست، کلید API خود را به عنوان نشانه مجوز ارسال کنید. نمونه کد را می توانید در زیر مشاهده کنید.

cURL PHP Node.js

curl --location --request POST 'https://n8n.ir/api/account' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/account",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
));

$response = curl_exec($curl);

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://n8n.ir/api/account',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: ''
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

محدودیت تعداد درخواست

API ما دارای یک محدود کننده تعداد درخواست برای محافظت از سرور در برابر افزایش تعداد درخواست ها (برای به حداکثر رساندن ثبات API) است. سیستم محدود کننده ما در حال حاضر به میزان 30 درخواست در هر 1 دقیقه محدود شده است. لطفا توجه داشته باشید که نرخ ممکن است با توجه به طرح مشترک تغییر کند.

چندین سربرگ در کنار پاسخ ارسال می شود و می توان آنها را برای تعیین اطلاعات مختلف در مورد درخواست بررسی کرد.

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP

مدیریت پاسخ

تمام پاسخ های API به طور پیش فرض در قالب JSON برگردانده می شوند که برای تبدیل آن به داده های قابل استفاده، باید از تابع مناسب مطابق با زبان استفاده شود. در PHP، تابع json_decode می تواند برای تبدیل داده ها به یک شی (پیش فرض) یا یک آرایه استفاده شود. بسیار مهم است که کلید خطا و کد هدر را بررسی کنید زیرا اطلاعاتی در مورد وجود یا عدم وجود خطا ارائه می دهد.

{
    "error": 1,
    "message": "An error occurred"
}

اسپلش سفارشی

لیست همه اسپلش های سفارشی

GET https://n8n.ir/api/splash?limit=2&page=1

برای دریافت صفحات اسپلش سفارشی از طریق API، می توانید از این درخواست استفاده کنید. همچنین می توانید داده ها را فیلتر کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
limit	اختیاری \| تعداد نتیجه در هر برگه
page	اختیاری \| شماره برگه مورد نظر

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/splash?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/splash?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "splash": [
            {
                "id": 1,
                "name": "Product 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Product 2 Promo",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

حساب کاربری

دریافت اطلاعات حساب

GET https://n8n.ir/api/account

برای دریافت اطلاعات در مورد حساب کاربری، می توانید درخواستی را به این لینک ارسال کنید تا داده های موجود در حساب کاربری ارسال شود.

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/account' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/account",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/account',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "data": {
        "id": 1,
        "email": "[email protected]",
        "username": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "expires": "2022-11-15 15:00:00",
        "registered": "2020-11-10 18:01:43"
    }
}

بروزرسانی حساب کاربری

PUT https://n8n.ir/api/account/update

برای بروزرسانی اطلاعات حساب کاربری، می توانید درخواستی را به این لینک ارسال کنید تا داده های موجود در حساب کاربری بروزرسانی شود.

cURL PHP Node.js

curl --location --request PUT 'https://n8n.ir/api/account/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "[email protected]",
    "password": "newpassword"
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/account/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "email": "[email protected]",
	    "password": "newpassword"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://n8n.ir/api/account/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "email": "[email protected]",
    "password": "newpassword"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "Account has been successfully updated."
}

دامنه ها

لیست همه دامنه ها

GET https://n8n.ir/api/domains?limit=2&page=1

برای دریافت کدهای دامنه خود از طریق API، می توانید از این درخواست استفاده کنید. همچنین می توانید داده ها را فیلتر کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
limit	اختیاری \| تعداد نتیجه در هر برگه
page	اختیاری \| شماره برگه مورد نظر

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/domains?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/domains?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "domains": [
            {
                "id": 1,
                "domain": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "id": 2,
                "domain": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
}

ایجاد دامنه

POST https://n8n.ir/api/domain/add

با استفاده از این درخواست می توان یک دامنه به حساب خود اضافه کنید. لطفاً مطمئن شوید که دامنه به درستی به سرور ما متصل شده است.

پارامتر	توضیحات
domain	ضروری \| دامنه شامل http یا https
redirectroot	اختیاری \| آدرس تغییر مسیر هنگامی که کسی مستقیم دامنه شما را باز میکند
redirect404	اختیاری \| صفحه 404 دلخواه

cURL PHP Node.js

curl --location --request POST 'https://n8n.ir/api/domain/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/domain/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "domain": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://n8n.ir/api/domain/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "id": 1
}

بروزرسانی دامنه

PUT https://n8n.ir/api/domain/:id/update

برای بروزرسانی یک دامنه، باید یک داده معتبر در JSON از طریق یک درخواست PUT ارسال کنید. داده ها باید به عنوان متن خام درخواست شما مطابق شکل زیر ارسال شوند. مثال زیر تمام پارامترهایی را که می توانید ارسال کنید نشان می دهد اما لازم نیست همه را ارسال کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
redirectroot	اختیاری \| آدرس تغییر مسیر هنگامی که کسی مستقیم دامنه شما را باز میکند
redirect404	اختیاری \| صفحه 404 دلخواه

cURL PHP Node.js

curl --location --request PUT 'https://n8n.ir/api/domain/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://n8n.ir/api/domain/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "Domain has been updated successfully."
}

حذف دامنه

DELETE https://n8n.ir/api/domain/:id/delete

برای حذف یک دامنه، باید یک درخواست DELETE ارسال کنید.

cURL PHP Node.js

curl --location --request DELETE 'https://n8n.ir/api/domain/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://n8n.ir/api/domain/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "Domain has been deleted successfully."
}

لینک

لیست همه لینک ها

GET https://n8n.ir/api/urls?limit=2&page=1&order=date

برای دریافت لینک های خود از طریق API، می توانید از این درخواست استفاده کنید. همچنین می توانید داده ها را فیلتر کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
limit	اختیاری \| تعداد نتیجه در هر برگه
page	اختیاری \| شماره برگه مورد نظر
order	مرتب سازی داده ها بین تاریخ میلادی یا کلیک (دلخواه)
short	اختیاری \| با استفاده از URL کوتاه جستجو کنید. توجه داشته باشید که وقتی از پارامتر short استفاده می‌کنید، تمام پارامترهای دیگر نادیده گرفته می‌شوند و اگر مطابقت داشت، پاسخ Single Link برگردانده می‌شود.

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/urls?limit=2&page=1&order=date' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/urls?limit=2&page=1&order=date",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/urls?limit=2&page=1&order=date',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "urls": [
            {
                "id": 2,
                "alias": "google",
                "shorturl": "https:\/\/n8n.ir\/google",
                "longurl": "https:\/\/google.com",
                "clicks": 0,
                "title": "Google",
                "description": "",
                "date": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "alias": "googlecanada",
                "shorturl": "https:\/\/n8n.ir\/googlecanada",
                "longurl": "https:\/\/google.ca",
                "clicks": 0,
                "title": "Google Canada",
                "description": "",
                "date": "2020-11-10 18:00:25"
            }
        ]
    }
}

دریافت اطلاعات لینک تکی

GET https://n8n.ir/api/url/:id

برای دریافت جزئیات یک لینک از طریق API، می توانید از این درخواست استفاده کنید.

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/url/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/url/:id",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/url/:id',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "id": 1,
    "details": {
        "id": 1,
        "shorturl": "https:\/\/n8n.ir\/googlecanada",
        "longurl": "https:\/\/google.com",
        "title": "Google",
        "description": "",
        "location": {
            "canada": "https:\/\/google.ca",
            "united states": "https:\/\/google.us"
        },
        "device": {
            "iphone": "https:\/\/google.com",
            "android": "https:\/\/google.com"
        },
        "expiry": null,
        "date": "2020-11-10 18:01:43"
    },
    "data": {
        "clicks": 0,
        "uniqueClicks": 0,
        "topCountries": 0,
        "topReferrers": 0,
        "topBrowsers": 0,
        "topOs": 0,
        "socialCount": {
            "facebook": 0,
            "twitter": 0,
            "google": 0
        }
    }
}

کوتاه کردن لینک

POST https://n8n.ir/api/url/add

برای کوتاه کردن یک پیوند، باید یک داده معتبر در JSON از طریق یک درخواست POST ارسال کنید. داده ها باید به عنوان متن خام درخواست شما مطابق شکل زیر ارسال شوند. مثال زیر تمام پارامترهایی را که می توانید ارسال کنید نشان می دهد اما لازم نیست همه را ارسال کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
url	ضروری \| لینک اصلی برای کوتاه شدن
custom	اختیاری \| اسلگ برای لینک کوتاه شده
type	اختیاری \| نوع تغییر مسیر [direct, frame, splash]، فقط id برای صفحه splash سفارشی یا overlay-id برای صفحات cta
password	اختیاری \| رمز عبور
domain	اختیاری \| دامنه
expiry	اختیاری \| تاریخ انقضا لینک به میلادی
geotarget	اختیاری \| منطقه جغرافیایی هدف
devicetarget	اختیاری \| دستگاه هدف
languagetarget	اختیاری \| زبان هدف
metatitle	اختیاری \| متاتایتل
metadescription	اختیاری \| متا دیسکریپشن
metaimage	اختیاری \| لینک تصویر png یا jpg
description	اختیاری \| یادداشت یا توضیحات
pixels	اختیاری \| آرایه ای از شناسه های پیکسل ها
channel	اختیاری \| آیدی کانال
deeplink	اختیاری \| ابجکت حاوی پیوندهای فروشگاه برنامه. هنگام استفاده از این ویژگی، مهم است که هدف گذاری دستگاه را نیز تنظیم کنید.
status	اختیاری \| عمومی یا خصوصی(پیشفرض)

cURL PHP Node.js

curl --location --request POST 'https://n8n.ir/api/url/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https:\/\/google.com",
    "status": "private",
    "custom": "google",
    "password": "mypass",
    "expiry": "2020-11-11 12:00:00",
    "type": "splash",
    "metatitle": "Not Google",
    "metadescription": "Not Google description",
    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
    "description": "For facebook",
    "pixels": [
        1,
        2,
        3,
        4
    ],
    "channel": 1,
    "deeplink": {
        "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
    },
    "geotarget": [
        {
            "location": "Canada",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "United States",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "device": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https:\/\/google.com"
        },
        {
            "language": "fr",
            "link": "https:\/\/google.ca"
        }
    ],
    "parameters": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "device": "gtm_source",
            "link": "api"
        }
    ]
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/url/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "url": "https:\/\/google.com",
	    "status": "private",
	    "custom": "google",
	    "password": "mypass",
	    "expiry": "2020-11-11 12:00:00",
	    "type": "splash",
	    "metatitle": "Not Google",
	    "metadescription": "Not Google description",
	    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
	    "description": "For facebook",
	    "pixels": [
	        1,
	        2,
	        3,
	        4
	    ],
	    "channel": 1,
	    "deeplink": {
	        "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
	        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
	    },
	    "geotarget": [
	        {
	            "location": "Canada",
	            "link": "https:\/\/google.ca"
	        },
	        {
	            "location": "United States",
	            "link": "https:\/\/google.us"
	        }
	    ],
	    "devicetarget": [
	        {
	            "device": "iPhone",
	            "link": "https:\/\/google.com"
	        },
	        {
	            "device": "Android",
	            "link": "https:\/\/google.com"
	        }
	    ],
	    "languagetarget": [
	        {
	            "language": "en",
	            "link": "https:\/\/google.com"
	        },
	        {
	            "language": "fr",
	            "link": "https:\/\/google.ca"
	        }
	    ],
	    "parameters": [
	        {
	            "name": "aff",
	            "value": "3"
	        },
	        {
	            "device": "gtm_source",
	            "link": "api"
	        }
	    ]
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://n8n.ir/api/url/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "url": "https:\/\/google.com",
    "status": "private",
    "custom": "google",
    "password": "mypass",
    "expiry": "2020-11-11 12:00:00",
    "type": "splash",
    "metatitle": "Not Google",
    "metadescription": "Not Google description",
    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
    "description": "For facebook",
    "pixels": [
        1,
        2,
        3,
        4
    ],
    "channel": 1,
    "deeplink": {
        "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
    },
    "geotarget": [
        {
            "location": "Canada",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "United States",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "device": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https:\/\/google.com"
        },
        {
            "language": "fr",
            "link": "https:\/\/google.ca"
        }
    ],
    "parameters": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "device": "gtm_source",
            "link": "api"
        }
    ]
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "id": 3,
    "shorturl": "https:\/\/n8n.ir\/google"
}

بروزرسانی لینک

PUT https://n8n.ir/api/url/:id/update

برای بروزرسانی یک پیوند، باید یک داده معتبر در JSON از طریق یک درخواست POST ارسال کنید. داده ها باید به عنوان متن خام درخواست شما مطابق شکل زیر ارسال شوند. مثال زیر تمام پارامترهایی را که می توانید ارسال کنید نشان می دهد اما لازم نیست همه را ارسال کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
url	ضروری \| لینک اصلی برای کوتاه شدن
custom	اختیاری \| اسلگ برای لینک کوتاه شده
type	اختیاری \| نوع تغییر مسیر [direct, frame, splash]
password	اختیاری \| رمز عبور
domain	اختیاری \| دامنه
expiry	اختیاری \| تاریخ انقضا لینک به میلادی
geotarget	اختیاری \| منطقه جغرافیایی هدف
devicetarget	اختیاری \| دستگاه هدف
languagetarget	اختیاری \| زبان هدف
metatitle	اختیاری \| متاتایتل
metadescription	اختیاری \| متا دیسکریپشن
metaimage	اختیاری \| لینک تصویر png یا jpg
pixels	اختیاری \| آرایه ای از شناسه های پیکسل ها
channel	اختیاری \| آیدی کانال
deeplink	اختیاری \| ابجکت حاوی پیوندهای فروشگاه برنامه. هنگام استفاده از این ویژگی، مهم است که هدف گذاری دستگاه را نیز تنظیم کنید.

cURL PHP Node.js

curl --location --request PUT 'https://n8n.ir/api/url/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https:\/\/google.com",
    "custom": "google",
    "password": "mypass",
    "expiry": "2020-11-11 12:00:00",
    "type": "splash",
    "pixels": [
        1,
        2,
        3,
        4
    ],
    "channel": 1,
    "deeplink": {
        "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
    },
    "geotarget": [
        {
            "location": "Canada",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "United States",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "device": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "parameters": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "device": "gtm_source",
            "link": "api"
        }
    ]
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/url/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "url": "https:\/\/google.com",
	    "custom": "google",
	    "password": "mypass",
	    "expiry": "2020-11-11 12:00:00",
	    "type": "splash",
	    "pixels": [
	        1,
	        2,
	        3,
	        4
	    ],
	    "channel": 1,
	    "deeplink": {
	        "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
	        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
	    },
	    "geotarget": [
	        {
	            "location": "Canada",
	            "link": "https:\/\/google.ca"
	        },
	        {
	            "location": "United States",
	            "link": "https:\/\/google.us"
	        }
	    ],
	    "devicetarget": [
	        {
	            "device": "iPhone",
	            "link": "https:\/\/google.com"
	        },
	        {
	            "device": "Android",
	            "link": "https:\/\/google.com"
	        }
	    ],
	    "parameters": [
	        {
	            "name": "aff",
	            "value": "3"
	        },
	        {
	            "device": "gtm_source",
	            "link": "api"
	        }
	    ]
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://n8n.ir/api/url/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "url": "https:\/\/google.com",
    "custom": "google",
    "password": "mypass",
    "expiry": "2020-11-11 12:00:00",
    "type": "splash",
    "pixels": [
        1,
        2,
        3,
        4
    ],
    "channel": 1,
    "deeplink": {
        "apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA&gl=US"
    },
    "geotarget": [
        {
            "location": "Canada",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "United States",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "device": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "parameters": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "device": "gtm_source",
            "link": "api"
        }
    ]
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "id": 3,
    "short": "https:\/\/n8n.ir\/google"
}

حذف لینک

DELETE https://n8n.ir/api/url/:id/delete

برای حذف یک لینک، باید یک درخواست DELETE ارسال کنید.

cURL PHP Node.js

curl --location --request DELETE 'https://n8n.ir/api/url/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/url/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://n8n.ir/api/url/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "Link has been deleted successfully"
}

پوشش های CTA

لیست همه پوشش های CTA

GET https://n8n.ir/api/overlay?limit=2&page=1

برای دریافت پوشش های CTAاز طریق API، می توانید از این درخواست استفاده کنید. همچنین می توانید داده ها را فیلتر کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
limit	اختیاری \| تعداد نتیجه در هر برگه
page	اختیاری \| شماره برگه مورد نظر

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/overlay?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/overlay?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "cta": [
            {
                "id": 1,
                "type": "message",
                "name": "Product 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "contact",
                "name": "Contact Page",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

پیکسل ها

لیست همه پیکسل ها

GET https://n8n.ir/api/pixels?limit=2&page=1

برای دریافت کدهای پیکسل خود از طریق API، می توانید از این درخواست استفاده کنید. همچنین می توانید داده ها را فیلتر کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
limit	اختیاری \| تعداد نتیجه در هر برگه
page	اختیاری \| شماره برگه مورد نظر

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/pixels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/pixels?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "pixels": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM Pixel",
                "tag": "GA-123456789",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "twitterpixel",
                "name": "Twitter Pixel",
                "tag": "1234567",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}

ایجاد پیکسل

POST https://n8n.ir/api/pixel/add

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

پارامتر	توضیحات
type	ضروری \| gtmpixel ، gapixel ، fbpixel ، adwordspixel ، linkedinpixel ، twitterpixel ، adrollpixel ، quorapixel ، pinterest ، bing ، snapchat ، reddit ، tiktok
name	ضروری \| نام دلخواه پیکسل
tag	ضروری \| تگ دلخواه پیکسل

cURL PHP Node.js

curl --location --request POST 'https://n8n.ir/api/pixel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/pixel/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "gtmpixel",
	    "name": "My GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://n8n.ir/api/pixel/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "type": "gtmpixel",
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "id": 1
}

بروزرسانی پیکسل

PUT https://n8n.ir/api/pixel/:id/update

برای بروزرسانی یک پیکسل، باید یک داده معتبر به JSON از طریق یک درخواست PUT ارسال کنید. داده ها باید به عنوان متن خام درخواست شما مطابق شکل زیر ارسال شوند. مثال زیر تمام پارامترهایی را که می توانید ارسال کنید نشان می دهد. لازم نیست همه را ارسال کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
name	اختیاری \| نام دلخواه برای پیکسل
tag	ضروری \| تگ دلخواه پیکسل

cURL PHP Node.js

curl --location --request PUT 'https://n8n.ir/api/pixel/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "My GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://n8n.ir/api/pixel/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "My GTM",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "Pixel has been updated successfully."
}

حذف پیکسل

DELETE https://n8n.ir/api/pixel/:id/delete

برای حذف پیکسل، باید یک درخواست DELETE ارسال کنید.

cURL PHP Node.js

curl --location --request DELETE 'https://n8n.ir/api/pixel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://n8n.ir/api/pixel/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "Pixel has been deleted successfully."
}

کانال

لیست کانال ها

GET https://n8n.ir/api/channels?limit=2&page=1

برای دریافت کانال های خود از طریق API، می توانید از این درخواست استفاده کنید. همچنین می توانید داده ها را فیلتر کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
limit	اختیاری \| تعداد نتیجه در هر برگه
page	اختیاری \| شماره برگه مورد نظر

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/channels?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/channels?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "channels": [
            {
                "id": 1,
                "name": "Channel 1",
                "description": "Description of channel 1",
                "color": "#000000",
                "starred": true
            },
            {
                "id": 2,
                "name": "Channel 2",
                "description": "Description of channel 2",
                "color": "#FF0000",
                "starred": false
            }
        ]
    }
}

لیست موارد موجود در کانال

GET https://n8n.ir/api/channel/:id?limit=1&page=1

برای دریافت موارد موجود در یک کانال انتخابی از طریق API، می توانید از این درخواست استفاده کنید. همچنین می توانید داده ها را فیلتر کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
limit	اختیاری \| تعداد نتیجه در هر برگه
page	اختیاری \| شماره برگه مورد نظر

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/channel/:id?limit=1&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/channel/:id?limit=1&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "items": [
            {
                "type": "links",
                "id": 1,
                "title": "My Sample Link",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/n8n.ir\/google",
                "date": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "My Sample Bio",
                "preview": "https:\/\/n8n.ir\/mybio",
                "link": "https:\/\/n8n.ir\/mybio",
                "date": "2022-06-01"
            }
        ]
    }
}

ایجاد کانال

POST https://n8n.ir/api/channel/add

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

پارامتر	توضیحات
name	ضروری \| نام کانال
description	اختیاری \| توضیحات کانال
color	اختیاری \| رنگ نشان کانال با کد هکس
starred	اختیاری \| کانال ویژه است؟ (مقادیر true یا false)

cURL PHP Node.js

curl --location --request POST 'https://n8n.ir/api/channel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/channel/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "New Channel",
	    "description": "my new channel",
	    "color": "#000000",
	    "starred": true
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://n8n.ir/api/channel/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "id": 3,
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}

اختصاص به کانال

POST https://n8n.ir/api/channel/:channelid/assign/:type/:itemid

با ارسال درخواست با شناسه کانال، نوع مورد (لینک ها، بیو یا qr) و شناسه مورد، می توان یک آیتم را به هر کانالی اختصاص داد.

پارامتر	توضیحات
:channelid	ضروری \| شناسه کانال
:type	ضروری \| links یا bio یا qr
:itemid	ضروری \| شناسه مورد

cURL PHP Node.js

curl --location --request POST 'https://n8n.ir/api/channel/:channelid/assign/:type/:itemid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://n8n.ir/api/channel/:channelid/assign/:type/:itemid',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "Item successfully added to the channel."
}

بروزرسانی کانال

PUT https://n8n.ir/api/channel/:id/update

برای به روز رسانی یک کانال، باید یک داده معتبر به JSON از طریق یک درخواست PUT ارسال کنید. داده ها باید به عنوان متن خام درخواست شما مطابق شکل زیر ارسال شوند. مثال زیر تمام پارامترهایی را که می توانید ارسال کنید نشان می دهد اما لازم نیست همه را ارسال کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
name	اختیاری \| نام کانال
description	اختیاری \| توضیحات کانال
color	اختیاری \| رنگ نشان کانال با کد هکس
starred	اختیاری \| کانال ویژه است؟ (مقادیر true یا false)

cURL PHP Node.js

curl --location --request PUT 'https://n8n.ir/api/channel/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "channel for items for Acme Corp",
    "color": "#FFFFFF",
    "starred": false
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Acme Corp",
	    "description": "channel for items for Acme Corp",
	    "color": "#FFFFFF",
	    "starred": false
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://n8n.ir/api/channel/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Acme Corp",
    "description": "channel for items for Acme Corp",
    "color": "#FFFFFF",
    "starred": false
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "Channel has been updated successfully."
}

حذف کانال

DELETE https://n8n.ir/api/channel/:id/delete

برای حذف یک کانال، باید یک درخواست DELETE ارسال کنید. همه موارد نیز از بین خواهند رفت.

cURL PHP Node.js

curl --location --request DELETE 'https://n8n.ir/api/channel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://n8n.ir/api/channel/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "Channel has been deleted successfully."
}

کد QR

لیست همه کد های QR

GET https://n8n.ir/api/qr?limit=2&page=1

برای دریافت کدهای QR خود از طریق API، می توانید از این درخواست استفاده کنید. همچنین می توانید داده ها را فیلتر کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
limit	اختیاری \| تعداد نتیجه در هر برگه
page	اختیاری \| شماره برگه مورد نظر

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/qr?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/qr?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "qrs": [
            {
                "id": 2,
                "link": "https:\/\/n8n.ir\/qr\/a2d5e",
                "scans": 0,
                "name": "Google",
                "date": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/n8n.ir\/qr\/b9edfe",
                "scans": 5,
                "name": "Google Canada",
                "date": "2020-11-10 18:00:25"
            }
        ]
    }
}

دریافت QR کد تکی

GET https://n8n.ir/api/qr/:id

برای دریافت جزئیات یک QR کد از طریق API، می توانید از این درخواست استفاده کنید.

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/qr/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/qr/:id",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/qr/:id',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "details": {
        "id": 1,
        "link": "https:\/\/n8n.ir\/qr\/b9edfe",
        "scans": 5,
        "name": "Google Canada",
        "date": "2020-11-10 18:00:25"
    },
    "data": {
        "clicks": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Unknown": "1"
        },
        "topReferrers": {
            "Direct, email and other": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "facebook": 0,
            "twitter": 0,
            "instagram": 0
        }
    }
}

ایجاد QR کد

POST https://n8n.ir/api/qr/add

برای ایجاد یک QR کد، باید یک داده معتبر در JSON از طریق یک درخواست POST ارسال کنید. داده ها باید به عنوان متن خام درخواست شما مطابق شکل زیر ارسال شوند. مثال زیر تمام پارامترهایی را که می توانید ارسال کنید نشان می دهد اما لازم نیست همه را ارسال کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
type	ضروری \| text ، vcard ، link ، email ، phone ، sms ، wifi
data	ضروری \| داده هایی که باید در داخل QR کد جاسازی شوند. بسته به نوع داده ها می توانند رشته یا آرایه باشند
background	اختیاری \| کد رنگ مانند rgb(255,255,255)
foreground	اختیاری \| کد رنگ مانند rgb(0,0,0)
logo	اختیاری \| لینک لوگو

cURL PHP Node.js

curl --location --request POST 'https://n8n.ir/api/qr/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/qr/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "link",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "foreground": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://n8n.ir/api/qr/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "id": 3,
    "link": "https:\/\/n8n.ir\/qr\/a58f79"
}

بروزرسانی QR کد

PUT https://n8n.ir/api/qr/:id/update

برای بروزرسانی یک کد QR، باید یک داده معتبر در JSON از طریق یک درخواست POST ارسال کنید. داده ها باید به عنوان متن خام درخواست شما مطابق شکل زیر ارسال شوند. مثال زیر تمام پارامترهایی را که می توانید ارسال کنید نشان می دهد اما لازم نیست همه را ارسال کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
data	ضروری \| داده هایی که باید در داخل QR کد جاسازی شوند. بسته به نوع داده ها می توانند رشته یا آرایه باشند
background	اختیاری \| کد رنگ مانند rgb(255,255,255)
foreground	اختیاری \| کد رنگ مانند rgb(0,0,0)
logo	اختیاری \| لینک لوگو

cURL PHP Node.js

curl --location --request PUT 'https://n8n.ir/api/qr/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "link",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "foreground": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://n8n.ir/api/qr/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "QR has been updated successfully."
}

حذف QR کد

DELETE https://n8n.ir/api/qr/:id/delete

برای حذف یک کد QR، باید یک درخواست DELETE ارسال کنید.

cURL PHP Node.js

curl --location --request DELETE 'https://n8n.ir/api/qr/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://n8n.ir/api/qr/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "QR Code has been deleted successfully."
}

کمپین ها

لیست کمپین ها

GET https://n8n.ir/api/campaigns?limit=2&page=1

برای دریافت کمپین های خود از طریق API، می توانید از این درخواست استفاده کنید. همچنین می توانید داده ها را فیلتر کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
limit	اختیاری \| تعداد نتیجه در هر برگه
page	اختیاری \| شماره برگه مورد نظر

cURL PHP Node.js

curl --location --request GET 'https://n8n.ir/api/campaigns?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://n8n.ir/api/campaigns?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "campaigns": [
            {
                "id": 1,
                "name": "Sample Campaign",
                "public": false,
                "rotator": false,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Facebook Campaign",
                "public": true,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
}

ایجاد کمپین

POST https://n8n.ir/api/campaign/add

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

پارامتر	توضیحات
name	اختیاری \| نام کمپین
slug	اختیاری \| نامک کمپین
public	اختیاری \| نوع دسترسی

cURL PHP Node.js

curl --location --request POST 'https://n8n.ir/api/campaign/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/campaign/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "New Campaign",
	    "slug": "new-campaign",
	    "public": true
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://n8n.ir/api/campaign/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "id": 3,
    "domain": "New Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
}

افزودن لینک به کمپین

POST https://n8n.ir/api/campaign/:campaignid/assign/:linkid

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

cURL PHP Node.js

curl --location --request POST 'https://n8n.ir/api/campaign/:campaignid/assign/:linkid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://n8n.ir/api/campaign/:campaignid/assign/:linkid',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "Link successfully added to the campaign."
}

بروزرسانی کمپین

PUT https://n8n.ir/api/campaign/:id/update

برای به‌روزرسانی یک کمپین، باید یک داده معتبر به JSON از طریق یک درخواست PUT ارسال کنید. داده ها باید به عنوان متن خام درخواست شما مطابق شکل زیر ارسال شوند. مثال زیر تمام پارامترهایی را که می توانید ارسال کنید نشان می دهد اما لازم نیست همه را ارسال کنید (برای اطلاعات بیشتر به جدول مراجعه کنید).

پارامتر	توضیحات
name	ضروری \| نام کمپین
slug	اختیاری \| نامک کمپین
public	اختیاری \| نوع دسترسی

cURL PHP Node.js

curl --location --request PUT 'https://n8n.ir/api/campaign/:id/update' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Twitter Campaign",
    "slug": "twitter-campaign",
    "public": true
}'

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Twitter Campaign",
	    "slug": "twitter-campaign",
	    "public": true
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://n8n.ir/api/campaign/:id/update',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Twitter Campaign",
    "slug": "twitter-campaign",
    "public": true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "id": 3,
    "domain": "Twitter Campaign",
    "public": true,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
}

حذف کمپین

DELETE https://n8n.ir/api/campaign/:id/delete

برای حذف یک کمپین، باید یک درخواست DELETE ارسال کنید.

cURL PHP Node.js

curl --location --request DELETE 'https://n8n.ir/api/campaign/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://n8n.ir/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://n8n.ir/api/campaign/:id/delete',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});

پاسخ سرور

{
    "error": 0,
    "message": "Campaign has been deleted successfully."
}