شروع ہوا چاہتا ہے
تصدیق
شرح کی حد
رسپانس ہینڈلنگ
برانڈڈ ڈومینز
حسب ضرورت سپلیش
لنکس
مہمات
پکسلز
چینلز
کھاتہ
کیو آر کوڈز
CTA اوورلیز

ڈویلپرز کے لیے API کا حوالہ v3

شروع ہوا چاہتا ہے

سسٹم کے ذریعے درخواستوں پر کارروائی کرنے کے لیے ایک API کلید درکار ہے۔ صارف کے رجسٹر ہونے کے بعد، اس صارف کے لیے ایک API کلید خود بخود تیار ہو جاتی ہے۔ API کلید ہر درخواست کے ساتھ بھیجی جانی چاہیے (نیچے مکمل مثال دیکھیں)۔ اگر API کلید نہیں بھیجی گئی ہے یا اس کی میعاد ختم ہو گئی ہے، تو ایک خرابی ہو گی۔ بیجا استعمال کو روکنے کے لیے براہ کرم اپنی API کلید کو خفیہ رکھنا یقینی بنائیں۔

تصدیق

API سسٹم کے ساتھ توثیق کرنے کے لیے، آپ کو ہر درخواست کے ساتھ اپنی API کلید کو اجازت کے ٹوکن کے طور پر بھیجنا ہوگا۔ آپ ذیل میں نمونہ کوڈ دیکھ سکتے ہیں۔

curl --location --request POST 'https://www.e.vg/api/url/add' \ 
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://www.e.vg/api/url/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer YOURAPIKEY",
    "Content-Type: application/json",
    ),
));

$response = curl_exec($curl);
شرح کی حد

ہمارے API کے پاس اس کے استحکام کو زیادہ سے زیادہ کرنے کی درخواستوں میں بڑھتی ہوئی وارداتوں کے خلاف حفاظت کے لیے شرح محدود ہے۔ ہمارا ریٹ محدود کرنے والا فی الحال 3000 درخواستوں پر فی 1 منٹ محدود ہے۔

جواب کے ساتھ کئی ہیڈر بھیجے جائیں گے اور درخواست کے بارے میں مختلف معلومات کا تعین کرنے کے لیے ان کا جائزہ لیا جا سکتا ہے۔

X-RateLimit-Limit: 3000
X-RateLimit-Remaining: 2999
X-RateLimit-Reset: TIMESTAMP
رسپانس ہینڈلنگ

تمام API جوابات JSON فارمیٹ میں بطور ڈیفالٹ واپس کیے جاتے ہیں۔ اسے قابل استعمال ڈیٹا میں تبدیل کرنے کے لیے زبان کے مطابق مناسب فنکشن استعمال کرنے کی ضرورت ہوگی۔ پی ایچ پی میں، فنکشن json_decode() ڈیٹا کو کسی آبجیکٹ (ڈیفالٹ) یا ایک صف میں تبدیل کرنے کے لیے استعمال کیا جا سکتا ہے (دوسرے پیرامیٹر کو سچ پر سیٹ کریں)۔ ایرر کلید کو چیک کرنا بہت ضروری ہے کیونکہ یہ معلومات فراہم کرتا ہے کہ آیا کوئی خرابی تھی یا نہیں۔ آپ ہیڈر کوڈ بھی چیک کر سکتے ہیں۔

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

برانڈڈ ڈومینز

برانڈڈ ڈومینز کی فہرست بنائیں
GET https://www.e.vg/api/domains?limit=2&page=1

API کے ذریعے اپنے برانڈڈ ڈومینز حاصل کرنے کے لیے، آپ اس اینڈ پوائنٹ کو استعمال کر سکتے ہیں۔ آپ ڈیٹا کو بھی فلٹر کر سکتے ہیں (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
limit (اختیاری) فی صفحہ ڈیٹا نتیجہ
page (اختیاری) موجودہ صفحہ کی درخواست
curl --location --request GET 'https://www.e.vg/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://www.e.vg/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "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://www.e.vg/api/domain/add

اس اختتامی نقطہ کا استعمال کرتے ہوئے ایک ڈومین شامل کیا جا سکتا ہے۔ براہ کرم یقینی بنائیں کہ ڈومین درست طریقے سے ہمارے سرور کی طرف اشارہ کیا گیا ہے۔

پیرامیٹر تفصیل
domain (ضروری) برانڈڈ ڈومین بشمول HTTP یا https
redirectroot (اختیاری) جب کوئی آپ کے ڈومین پر جاتا ہے تو روٹ ری ڈائریکٹ
redirect404 (اختیاری) کسٹم 404 ری ڈائریکٹ
curl --location --request POST 'https://www.e.vg/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://www.e.vg/api/domain/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  'domain' => 'https://domain1.com',
  'redirectroot' => 'https://rootdomain.com',
  'redirect404' => 'https://rootdomain.com/404',
)),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "id": 1
}
ڈومین کو اپ ڈیٹ کریں۔
PUT https://www.e.vg/api/domain/:id/update

برانڈڈ ڈومین کو اپ ڈیٹ کرنے کے لیے، آپ کو PUT درخواست کے ذریعے JSON میں ایک درست ڈیٹا بھیجنا ہوگا۔ ڈیٹا کو آپ کی درخواست کے خام جسم کے طور پر بھیجا جانا چاہیے جیسا کہ ذیل میں دکھایا گیا ہے۔ نیچے دی گئی مثال ان تمام پیرامیٹرز کو دکھاتی ہے جو آپ بھیج سکتے ہیں لیکن آپ کو سبھی بھیجنے کی ضرورت نہیں ہے (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
redirectroot (اختیاری) جب کوئی آپ کے ڈومین پر جاتا ہے تو روٹ ری ڈائریکٹ
redirect404 (اختیاری) کسٹم 404 ری ڈائریکٹ
curl --location --request PUT 'https://www.e.vg/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://www.e.vg/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  'redirectroot' => 'https://rootdomain-new.com',
  'redirect404' => 'https://rootdomain-new.com/404',
)),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "Domain has been updated successfully."
}
ڈومین حذف کریں۔
DELETE https://www.e.vg/api/domain/:id/delete

ڈومین کو حذف کرنے کے لیے، آپ کو حذف کی درخواست بھیجنے کی ضرورت ہے۔

curl --location --request DELETE 'https://www.e.vg/api/domain/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "Domain has been deleted successfully."
}

حسب ضرورت سپلیش

حسب ضرورت سپلیش کی فہرست بنائیں
GET https://www.e.vg/api/splash?limit=2&page=1

API کے ذریعے حسب ضرورت سپلیش پیجز حاصل کرنے کے لیے، آپ اس اینڈ پوائنٹ کو استعمال کر سکتے ہیں۔ آپ ڈیٹا کو بھی فلٹر کر سکتے ہیں (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
limit (اختیاری) فی صفحہ ڈیٹا نتیجہ
page (اختیاری) موجودہ صفحہ کی درخواست
curl --location --request GET 'https://www.e.vg/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://www.e.vg/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "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://www.e.vg/api/campaigns?limit=2&page=1

API کے ذریعے اپنی مہمات حاصل کرنے کے لیے، آپ اس اختتامی نقطہ کو استعمال کر سکتے ہیں۔ آپ ڈیٹا کو بھی فلٹر کر سکتے ہیں (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
limit (اختیاری) فی صفحہ ڈیٹا نتیجہ
page (اختیاری) موجودہ صفحہ کی درخواست
curl --location --request GET 'https://www.e.vg/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://www.e.vg/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "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://www.e.vg/api/campaign/add

اس اختتامی نقطہ کا استعمال کرتے ہوئے ایک مہم شامل کی جا سکتی ہے۔

پیرامیٹر تفصیل
name (اختیاری) مہم کا نام
slug (اختیاری) روٹیٹر سلگ
public (اختیاری) رسائی
curl --location --request POST 'https://www.e.vg/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://www.e.vg/api/campaign/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  'name' => 'New Campaign',
  'slug' => 'new-campaign',
  'public' => true,
)),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "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://www.e.vg/api/campaign/:campaignid/assign/:linkid

اس اختتامی نقطہ کا استعمال کرتے ہوئے مہم کے لیے ایک مختصر لنک تفویض کیا جا سکتا ہے۔ اختتامی نقطہ کے لیے مہم ID اور مختصر لنک ID درکار ہے۔

curl --location --request POST 'https://www.e.vg/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://www.e.vg/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "Link successfully added to the campaign."
}
مہم کو اپ ڈیٹ کریں۔
PUT https://www.e.vg/api/campaign/:id/update

مہم کو اپ ڈیٹ کرنے کے لیے، آپ کو PUT درخواست کے ذریعے JSON میں ایک درست ڈیٹا بھیجنا ہوگا۔ ڈیٹا کو آپ کی درخواست کے خام جسم کے طور پر بھیجا جانا چاہیے جیسا کہ ذیل میں دکھایا گیا ہے۔ نیچے دی گئی مثال ان تمام پیرامیٹرز کو دکھاتی ہے جو آپ بھیج سکتے ہیں لیکن آپ کو سبھی بھیجنے کی ضرورت نہیں ہے (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
name (ضروری) مہم کا نام
slug (اختیاری) روٹیٹر سلگ
public (اختیاری) رسائی
curl --location --request PUT 'https://www.e.vg/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://www.e.vg/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  'name' => 'Twitter Campaign',
  'slug' => 'twitter-campaign',
  'public' => true,
)),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "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://www.e.vg/api/campaign/:id/delete

کسی مہم کو حذف کرنے کے لیے، آپ کو DELETE کی درخواست بھیجنی ہوگی۔

curl --location --request DELETE 'https://www.e.vg/api/campaign/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "Campaign has been deleted successfully."
}

پکسلز

پکسلز کی فہرست بنائیں
GET https://www.e.vg/api/pixels?limit=2&page=1

API کے ذریعے اپنے پکسلز کوڈز حاصل کرنے کے لیے، آپ اس اینڈ پوائنٹ کو استعمال کر سکتے ہیں۔ آپ ڈیٹا کو بھی فلٹر کر سکتے ہیں (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
limit (اختیاری) فی صفحہ ڈیٹا نتیجہ
page (اختیاری) موجودہ صفحہ کی درخواست
curl --location --request GET 'https://www.e.vg/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://www.e.vg/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "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://www.e.vg/api/pixel/add

اس اختتامی نقطہ کا استعمال کرتے ہوئے ایک پکسل بنایا جا سکتا ہے۔ آپ کو پکسل کی قسم اور ٹیگ بھیجنے کی ضرورت ہے۔

پیرامیٹر تفصیل
type (required) gtmpixel | gapixel | fbpixel | adwordspixel | linkedinpixel | twitterpixel | adrollpixel | quorapixel | pinterest | bing | snapchat | reddit | tiktok
name (ضروری) آپ کے پکسل کے لیے حسب ضرورت نام
tag (ضروری) پکسل کے لیے ٹیگ
curl --location --request POST 'https://www.e.vg/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://www.e.vg/api/pixel/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  'type' => 'gtmpixel',
  'name' => 'My GTM',
  'tag' => 'GTM-ABCDE',
)),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "id": 1
}
پکسل کو اپ ڈیٹ کریں۔
PUT https://www.e.vg/api/pixel/:id/update

ایک پکسل کو اپ ڈیٹ کرنے کے لیے، آپ کو PUT درخواست کے ذریعے JSON میں ایک درست ڈیٹا بھیجنا ہوگا۔ ڈیٹا کو آپ کی درخواست کے خام جسم کے طور پر بھیجا جانا چاہیے جیسا کہ ذیل میں دکھایا گیا ہے۔ نیچے دی گئی مثال ان تمام پیرامیٹرز کو دکھاتی ہے جو آپ بھیج سکتے ہیں لیکن آپ کو سبھی بھیجنے کی ضرورت نہیں ہے (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
name (اختیاری) آپ کے پکسل کے لیے حسب ضرورت نام
tag (ضروری) پکسل کے لیے ٹیگ
curl --location --request PUT 'https://www.e.vg/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://www.e.vg/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  'name' => 'My GTM',
  'tag' => 'GTM-ABCDE',
)),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "Pixel has been updated successfully."
}
Pixel کو حذف کریں۔
DELETE https://www.e.vg/api/pixel/:id/delete

ایک پکسل کو حذف کرنے کے لیے، آپ کو DELETE کی درخواست بھیجنے کی ضرورت ہے۔

curl --location --request DELETE 'https://www.e.vg/api/pixel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "Pixel has been deleted successfully."
}

چینلز

چینلز کی فہرست بنائیں
GET https://www.e.vg/api/channels?limit=2&page=1

API کے ذریعے اپنے چینلز حاصل کرنے کے لیے، آپ اس اینڈ پوائنٹ کو استعمال کر سکتے ہیں۔ آپ ڈیٹا کو بھی فلٹر کر سکتے ہیں (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
limit (اختیاری) فی صفحہ ڈیٹا نتیجہ
page (اختیاری) موجودہ صفحہ کی درخواست
curl --location --request GET 'https://www.e.vg/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://www.e.vg/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "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://www.e.vg/api/channel/:id?limit=1&page=1

API کے ذریعے منتخب چینلز میں آئٹمز حاصل کرنے کے لیے، آپ اس اختتامی نقطہ کو استعمال کر سکتے ہیں۔ آپ ڈیٹا کو بھی فلٹر کر سکتے ہیں (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
limit (اختیاری) فی صفحہ ڈیٹا نتیجہ
page (اختیاری) موجودہ صفحہ کی درخواست
curl --location --request GET 'https://www.e.vg/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://www.e.vg/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "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:\/\/www.e.vg\/google",
                "date": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "My Sample Bio",
                "preview": "https:\/\/www.e.vg\/mybio",
                "link": "https:\/\/www.e.vg\/mybio",
                "date": "2022-06-01"
            }
        ]
    }
}
ایک چینل بنائیں
POST https://www.e.vg/api/channel/add

اس اختتامی نقطہ کا استعمال کرتے ہوئے ایک چینل شامل کیا جا سکتا ہے۔

پیرامیٹر تفصیل
name (ضروری) چینل کا نام
description (اختیاری) چینل کی تفصیل
color (اختیاری) چینل بیج کا رنگ (HEX)
starred (اختیاری) چینل کو اسٹار کریں یا نہیں (سچ یا غلط)
curl --location --request POST 'https://www.e.vg/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://www.e.vg/api/channel/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  'name' => 'New Channel',
  'description' => 'my new channel',
  'color' => '#000000',
  'starred' => true,
)),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "id": 3,
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}
کسی چینل کو ایک آئٹم تفویض کریں۔
POST https://www.e.vg/api/channel/:channelid/assign/:type/:itemid

چینل آئی ڈی، آئٹم کی قسم (لنک، بائیو یا کیو آر) اور آئٹم آئی ڈی کے ساتھ درخواست بھیج کر کسی بھی چینل کو آئٹم تفویض کیا جا سکتا ہے۔

پیرامیٹر تفصیل
:channelid (ضروری) چینل آئی ڈی
:type (ضروری) لنکس یا بائیو یا کیو آر
:itemid (ضروری) آئٹم کی شناخت
curl --location --request POST 'https://www.e.vg/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://www.e.vg/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "Item successfully added to the channel."
}
چینل کو اپ ڈیٹ کریں۔
PUT https://www.e.vg/api/channel/:id/update

چینل کو اپ ڈیٹ کرنے کے لیے، آپ کو PUT درخواست کے ذریعے JSON میں ایک درست ڈیٹا بھیجنا ہوگا۔ ڈیٹا کو آپ کی درخواست کے خام جسم کے طور پر بھیجا جانا چاہیے جیسا کہ ذیل میں دکھایا گیا ہے۔ نیچے دی گئی مثال ان تمام پیرامیٹرز کو دکھاتی ہے جو آپ بھیج سکتے ہیں لیکن آپ کو سبھی بھیجنے کی ضرورت نہیں ہے (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
name (اختیاری) چینل کا نام
description (اختیاری) چینل کی تفصیل
color (اختیاری) چینل بیج کا رنگ (HEX)
starred (اختیاری) چینل کو اسٹار کریں یا نہیں (سچ یا غلط)
curl --location --request PUT 'https://www.e.vg/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://www.e.vg/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  'name' => 'Acme Corp',
  'description' => 'channel for items for Acme Corp',
  'color' => '#FFFFFF',
  'starred' => false,
)),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "Channel has been updated successfully."
}
چینل کو حذف کریں۔
DELETE https://www.e.vg/api/channel/:id/delete

کسی چینل کو حذف کرنے کے لیے، آپ کو DELETE کی درخواست بھیجنی ہوگی۔ تمام آئٹمز کو بھی غیر تفویض کر دیا جائے گا۔

curl --location --request DELETE 'https://www.e.vg/api/channel/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "Channel has been deleted successfully."
}

کھاتہ

اکاؤنٹ حاصل کریں۔
GET https://www.e.vg/api/account

اکاؤنٹ کے بارے میں معلومات حاصل کرنے کے لیے، آپ اس اینڈ پوائنٹ پر ایک درخواست بھیج سکتے ہیں اور یہ اکاؤنٹ پر ڈیٹا واپس کر دے گا۔

curl --location --request GET 'https://www.e.vg/api/account' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "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://www.e.vg/api/account/update

اکاؤنٹ سے متعلق معلومات کو اپ ڈیٹ کرنے کے لیے، آپ اس اینڈ پوائنٹ پر ایک درخواست بھیج سکتے ہیں اور یہ اکاؤنٹ پر ڈیٹا کو اپ ڈیٹ کر دے گا۔

curl --location --request PUT 'https://www.e.vg/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://www.e.vg/api/account/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  'email' => '[email protected]',
  'password' => 'newpassword',
)),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "Account has been successfully updated."
}

کیو آر کوڈز

کیو آر کوڈز کی فہرست بنائیں
GET https://www.e.vg/api/qr?limit=2&page=1

API کے ذریعے اپنے QR کوڈز حاصل کرنے کے لیے، آپ اس اینڈ پوائنٹ کو استعمال کر سکتے ہیں۔ آپ ڈیٹا کو بھی فلٹر کر سکتے ہیں (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
limit (اختیاری) فی صفحہ ڈیٹا نتیجہ
page (اختیاری) موجودہ صفحہ کی درخواست
curl --location --request GET 'https://www.e.vg/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://www.e.vg/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": "0",
    "data": {
        "result": 2,
        "perpage": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "qrs": [
            {
                "id": 2,
                "link": "https:\/\/www.e.vg\/qr\/a2d5e",
                "scans": 0,
                "name": "Google",
                "date": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/www.e.vg\/qr\/b9edfe",
                "scans": 5,
                "name": "Google Canada",
                "date": "2020-11-10 18:00:25"
            }
        ]
    }
}
ایک واحد QR کوڈ حاصل کریں۔
GET https://www.e.vg/api/qr/:id

API کے ذریعے ایک QR کوڈ کی تفصیلات حاصل کرنے کے لیے، آپ اس اختتامی نقطہ کو استعمال کر سکتے ہیں۔

curl --location --request GET 'https://www.e.vg/api/qr/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "details": {
        "id": 1,
        "link": "https:\/\/www.e.vg\/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
        }
    }
}
ایک کیو آر کوڈ بنائیں
POST https://www.e.vg/api/qr/add

QR کوڈ بنانے کے لیے، آپ کو JSON میں POST کی درخواست کے ذریعے ایک درست ڈیٹا بھیجنا ہوگا۔ ڈیٹا کو آپ کی درخواست کے خام جسم کے طور پر بھیجا جانا چاہیے جیسا کہ ذیل میں دکھایا گیا ہے۔ نیچے دی گئی مثال ان تمام پیرامیٹرز کو دکھاتی ہے جو آپ بھیج سکتے ہیں لیکن آپ کو سبھی بھیجنے کی ضرورت نہیں ہے (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
type (ضروری) متن | وی کارڈ | لنک | ای میل | فون | ایس ایم ایس | وائی ​​فائی
data (ضروری) ڈیٹا کو QR کوڈ کے اندر سرایت کرنا ہے۔ قسم کے لحاظ سے ڈیٹا سٹرنگ یا ارے ہو سکتا ہے۔
background (اختیاری) RGB رنگ جیسے rgb(255,255,255)
foreground (اختیاری) RGB رنگ جیسے rgb(0,0,0)
logo (اختیاری) لوگو کا راستہ یا تو png یا jpg
curl --location --request POST 'https://www.e.vg/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://www.e.vg/api/qr/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  '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;
سرور کا جواب
{
    "error": 0,
    "id": 3,
    "link": "https:\/\/www.e.vg\/qr\/a58f79"
}
QR کوڈ کو اپ ڈیٹ کریں۔
PUT https://www.e.vg/api/qr/:id/update

QR کوڈ کو اپ ڈیٹ کرنے کے لیے، آپ کو PUT درخواست کے ذریعے JSON میں ایک درست ڈیٹا بھیجنا ہوگا۔ ڈیٹا کو آپ کی درخواست کے خام جسم کے طور پر بھیجا جانا چاہیے جیسا کہ ذیل میں دکھایا گیا ہے۔ نیچے دی گئی مثال ان تمام پیرامیٹرز کو دکھاتی ہے جو آپ بھیج سکتے ہیں لیکن آپ کو سبھی بھیجنے کی ضرورت نہیں ہے (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
data (ضروری) ڈیٹا کو QR کوڈ کے اندر سرایت کرنا ہے۔ قسم کے لحاظ سے ڈیٹا سٹرنگ یا ارے ہو سکتا ہے۔
background (اختیاری) RGB رنگ جیسے rgb(255,255,255)
foreground (اختیاری) RGB رنگ جیسے rgb(0,0,0)
logo (اختیاری) لوگو کا راستہ یا تو png یا jpg
curl --location --request PUT 'https://www.e.vg/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://www.e.vg/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  '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;
سرور کا جواب
{
    "error": 0,
    "message": "QR has been updated successfully."
}
QR کوڈ حذف کریں۔
DELETE https://www.e.vg/api/qr/:id/delete

QR کوڈ کو حذف کرنے کے لیے، آپ کو DELETE کی درخواست بھیجنی ہوگی۔

curl --location --request DELETE 'https://www.e.vg/api/qr/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "QR Code has been deleted successfully."
}

CTA اوورلیز

CTA اوورلیز کی فہرست بنائیں
GET https://www.e.vg/api/overlay?limit=2&page=1

API کے ذریعے cta اوورلیز حاصل کرنے کے لیے، آپ اس اینڈ پوائنٹ کو استعمال کر سکتے ہیں۔ آپ ڈیٹا کو بھی فلٹر کر سکتے ہیں (مزید معلومات کے لیے جدول دیکھیں)۔

پیرامیٹر تفصیل
limit (اختیاری) فی صفحہ ڈیٹا نتیجہ
page (اختیاری) موجودہ صفحہ کی درخواست
curl --location --request GET 'https://www.e.vg/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://www.e.vg/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "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://www.e.vg/api/users?filter=free

پلیٹ فارم پر موجود تمام صارفین کی فہرست حاصل کریں۔ یو آر ایل میں فلٹر پیرامیٹر بھیج کر ڈیٹا کو فلٹر کیا جا سکتا ہے۔

پیرامیٹر تفصیل
filter منتظم | مفت | پرو
email ای میل کے ذریعے صارف کو تلاش کریں۔
curl --location --request GET 'https://www.e.vg/api/users?filter=free' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://www.e.vg/api/users?filter=free",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "data": [
        {
            "id": 2,
            "email": "[email protected]",
            "username": "sample2user",
            "avatar": "https:\\\/\\\/domain.com\/content\/avatar2.png",
            "status": "free",
            "planid": 1,
            "expires": null,
            "registered": "2020-11-10 18:01:43",
            "apikey": "ABC123DEF456"
        },
        {
            "id": 1,
            "email": "[email protected]",
            "username": "sampleuser",
            "avatar": "https:\\\/\\\/domain.com\/content\/avatar.png",
            "status": "pro",
            "planid": 2,
            "expires": "2022-11-15 15:00:00",
            "registered": "2020-11-10 18:01:43",
            "apikey": "ABC123DEF456"
        }
    ]
}
ایک واحد صارف کی فہرست بنائیں
GET https://www.e.vg/api/user/:id

ایک صارف کے لیے ڈیٹا حاصل کریں۔

curl --location --request GET 'https://www.e.vg/api/user/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://www.e.vg/api/user/:id",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "data": {
        "id": 2,
        "email": "[email protected]",
        "username": "sample2user",
        "avatar": "https:\\\/\\\/domain.com\/content\/avatar2.png",
        "status": "free",
        "planid": 1,
        "expires": null,
        "registered": "2020-11-10 18:01:43",
        "apikey": "ABC123DEF456"
    }
}
صارف بنائیں
POST https://www.e.vg/api/user/add

صارف بنانے کے لیے، اس اینڈ پوائنٹ کا استعمال کریں اور درج ذیل معلومات کو JSON کے بطور بھیجیں۔

پیرامیٹر تفصیل
username (ضروری) صارف کا صارف نام۔ درست ہونے کی ضرورت ہے۔
email (ضروری) صارف کا ای میل۔ درست ہونے کی ضرورت ہے۔
password (ضروری) صارف کا پاس ورڈ۔ کم از کم 5 حروف۔
planid (اختیاری) پریمیم پلان۔ یہ ایڈمن پینل میں پایا جا سکتا ہے۔
expiration (اختیاری) رکنیت کی میعاد ختم ہونے کی مثال 26-12-2020 12:00:00
curl --location --request POST 'https://www.e.vg/api/user/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "user",
    "password": "1234567891011",
    "email": "[email protected]",
    "planid": 1,
    "expiration": "2020-11-20 11:00:00"
}'
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://www.e.vg/api/user/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  'username' => 'user',
  'password' => '1234567891011',
  'email' => '[email protected]',
  'planid' => 1,
  'expiration' => '2020-11-20 11:00:00',
)),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "User has been registered.",
    "data": {
        "id": 3,
        "email": "[email protected]",
        "username": "user"
    }
}
صارف کو حذف کریں۔
DELETE https://www.e.vg/api/user/:id/delete

کسی صارف کو حذف کرنے کے لیے، اس اختتامی نقطہ کا استعمال کریں۔

curl --location --request DELETE 'https://www.e.vg/api/user/:id/delete' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://www.e.vg/api/user/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "User has been deleted."
}
لاگ ان صارف
GET https://www.e.vg/api/user/login/:id

یہ اختتامی نقطہ ایک منفرد لنک تیار کرے گا جو صارف کو خود بخود پلیٹ فارم پر لاگ ان کرنے کی اجازت دے گا۔ SSO لاگ ان یو آر ایل 1 گھنٹہ کے لیے درست ہیں اور انہیں ایک بار استعمال کیا جا سکتا ہے۔

curl --location --request GET 'https://www.e.vg/api/user/login/:id' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://www.e.vg/api/user/login/:id",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "url": "https:\/\/www.e.vg\/user\/login\/sso\/zfwsvwcdnfkstuhufamnznzjewtninnv"
}

منصوبے

یہ اختتامی نقطہ صرف منتظم کے استحقاق کے حامل صارفین کے لیے قابل رسائی ہے۔

منصوبوں کی فہرست بنائیں
GET https://www.e.vg/api/plans

پلیٹ فارم پر تمام منصوبوں کی فہرست حاصل کریں۔

curl --location --request GET 'https://www.e.vg/api/plans' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://www.e.vg/api/plans",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "data": [
        {
            "id": 2,
            "name": "Business",
            "free": false,
            "prices": {
                "monthly": 9.99,
                "yearly": 99.99,
                "lifetime": 999.99
            },
            "limits": {
                "links": 100,
                "clicks": 100000,
                "retention": 60,
                "custom": {
                    "enabled": "0"
                },
                "team": {
                    "enabled": "0",
                    "count": "0"
                },
                "splash": {
                    "enabled": "1",
                    "count": "5"
                },
                "overlay": {
                    "enabled": "1",
                    "count": "10"
                },
                "pixels": {
                    "enabled": "1",
                    "count": "10"
                },
                "domain": {
                    "enabled": "1",
                    "count": "1"
                },
                "multiple": {
                    "enabled": "0"
                },
                "alias": {
                    "enabled": "1"
                },
                "device": {
                    "enabled": "0"
                },
                "geo": {
                    "enabled": "0"
                },
                "bundle": {
                    "enabled": "0"
                },
                "parameters": {
                    "enabled": "0"
                },
                "export": {
                    "enabled": "0"
                },
                "api": {
                    "enabled": "0"
                }
            }
        },
        {
            "id": 1,
            "name": "Starter",
            "free": true,
            "prices": null,
            "limits": {
                "links": 10,
                "clicks": 1000,
                "retention": 7,
                "custom": {
                    "enabled": "0"
                },
                "team": {
                    "enabled": "0",
                    "count": "0"
                },
                "splash": {
                    "enabled": "0",
                    "count": "0"
                },
                "overlay": {
                    "enabled": "0",
                    "count": "10"
                },
                "pixels": {
                    "enabled": "0",
                    "count": "10"
                },
                "domain": {
                    "enabled": "0",
                    "count": "0"
                },
                "multiple": {
                    "enabled": "0"
                },
                "alias": {
                    "enabled": "0"
                },
                "device": {
                    "enabled": "0"
                },
                "geo": {
                    "enabled": "0"
                },
                "bundle": {
                    "enabled": "0"
                },
                "parameters": {
                    "enabled": "0"
                },
                "export": {
                    "enabled": "0"
                },
                "api": {
                    "enabled": "0"
                }
            }
        }
    ]
}
کسی صارف کو کسی پلان میں سبسکرائب کریں۔
PUT https://www.e.vg/api/plan/:planid/user/:userid

کسی صارف کو پلان کے لیے سبسکرائب کرنے کے لیے، اس اینڈ پوائنٹ پر پلان آئی ڈی اور یوزر آئی ڈی کے ساتھ PUT کی درخواست بھیجیں۔ رکنیت کی قسم اور میعاد ختم ہونے کی تاریخ بتانے کی ضرورت ہوگی۔ اگر میعاد ختم ہونے کی تاریخ بیان نہیں کی گئی ہے تو، تاریخ کو قسم کے مطابق ایڈجسٹ کیا جائے گا۔

پیرامیٹر تفصیل
type ماہانہ | سالانہ | زندگی بھر
expiration (اختیاری) پلان کی میعاد ختم ہونے کی تاریخ جیسے2022-12-28 10:38:36
curl --location --request PUT 'https://www.e.vg/api/plan/:planid/user/:userid' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "monthly",
    "expiration": "2022-12-28 10:38:36"
}'
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://www.e.vg/api/plan/:planid/user/:userid",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => array(
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ),
    CURLOPT_POSTFIELDS => json_encode(array (
  'type' => 'monthly',
  'expiration' => '2022-12-28 10:38:36',
)),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
سرور کا جواب
{
    "error": 0,
    "message": "User has been subscribed to this plan."
}