開発者向け API リファレンス

Getting Started

An API key is required for requests to be processed by the system. Once a user registers, an API key is automatically generated for this user. The API key must be sent with each request (see full example below). If the API key is not sent or is expired, there will be an error. Please make sure to keep your API key secret to prevent abuse.

Authentication

To authenticate with the API system, you need to send your API key as an authorization token with each request. You can see sample code below.

סלסול --מיקום --בקש POST 'https://urlkai.com/api/account' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();
curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
));

$response = curl_exec($curl); 
var request = require('בקשה');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/account',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: ''
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/account"
תוכן מנה = {}
headers = {
  'הרשאה': 'נושא YOURAPIKEY',
  'סוג תוכן': 'יישום/json'
}
response = requests.request("GET", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Rate Limit

Our API has a rate limiter to safeguard against spike in requests to maximize its stability. Our rate limiter is currently caped at 30 requests per 1 minute. Please note that the rate might change according to the subscribed plan.

Several headers will be sent alongside the response and these can be examined to determine various information about the request.

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

All API response are returned in JSON format by default. To convert this into usable data, the appropriate function will need to be used according to the language. In PHP, the function json_decode() can be used to convert the data to either an object (default) or an array (set the second parameter to true). It is very important to check the error key as that provides information on whether there was an error or not. You can also check the header code.

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

חשבון

קבל חשבון
GET https://urlkai.com/api/account

כדי לקבל מידע על החשבון, אתה יכול לשלוח בקשה לנקודת קצה זו והיא תחזיר נתונים בחשבון.

סלסול --מיקום --בקש GET 'https://urlkai.com/api/account' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'קבל',
    'url': 'https://urlkai.com/api/account',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/account"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("GET", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "data": {
        "id": 1,
        "email": " [מוגן בדוא"ל] ",
        "username": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "בעד",
        "פג תוקף": "2022-11-15 15:00:00",
        "רשום": "2020-11-10 18:01:43"
    }
} 
עדכון חשבון
PUT https://urlkai.com/api/account/update

כדי לעדכן מידע על החשבון, אתה יכול לשלוח בקשה לנקודת קצה זו והיא תעדכן נתונים בחשבון.

curl --location --request PUT 'https://urlkai.com/api/account/update' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \
--data-raw '{
    "email": " [מוגן בדוא"ל] ",
    "password": "סיסמה חדשה"
}' 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "email": " [מוגן בדוא"ל] ",
	    "password": "סיסמה חדשה"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'PUT',
    'url': 'https://urlkai.com/api/account/update',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: JSON.stringify({
    "email": " [מוגן בדוא"ל] ",
    "password": "סיסמה חדשה"
}),
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/account/update"
מטען = {
    "email": " [מוגן בדוא"ל] ",
    "password": "סיסמה חדשה"
}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("PUT", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{
    "email": " [מוגן בדוא"ל] ",
    "password": "סיסמה חדשה"
}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": "החשבון עודכן בהצלחה."
} 

דומיינים ממותגים

רשימת דומיינים ממותגים
GET https://urlkai.com/api/domains?limit=2&page=1

כדי לקבל את הדומיינים הממותגים שלך דרך ה-API, אתה יכול להשתמש בנקודת קצה זו. באפשרותך גם לסנן נתונים (ראה טבלה לקבלת מידע נוסף).

פרמטר תיאור
גבול (אופציונלי) תוצאת נתונים לכל עמוד
דף (אופציונלי) בקשה לדף נוכחי
סלסול --מיקום --בקש קבל 'https://urlkai.com/api/domains?limit=2&page=1' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'קבל',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/domains?limit=2&page=1"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("GET", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": "0",
    "data": {
        "תוצאה": 2,
        "perpage": 2,
        "Currentpage": 1,
        "העמוד הבא": 1,
        "MaxPage": 1,
        "דומיינים": [
            {
                "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://urlkai.com/api/domain/add

ניתן להוסיף תחום באמצעות נקודת קצה זו. יש לוודא שהדומיין מופנה כראוי לשרת שלנו.

פרמטר תיאור
תחום (חובה) דומיין ממותג כולל http או https
redirectroot (אופציונלי) הפניית בסיס כאשר מישהו מבקר בדומיין שלך
הפניה מחדש404 (אופציונלי) ניתוב מחדש מותאם אישית של 404
סלסול --מיקום --בקש הודעה 'https://urlkai.com/api/domain/add' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \
--data-raw '{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/domain/add",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "domain": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/domain/add',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: JSON.stringify({
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/domain/add"
מטען = {
    "domain": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("POST", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "ID": 1
} 
ドメインを更新
PUT https://urlkai.com/api/domain/:id/update

כדי לעדכן דומיין ממותג, עליך לשלוח נתונים חוקיים ב-JSON באמצעות בקשת PUT. יש לשלוח את הנתונים כגוף הגולמי של בקשתך כפי שמוצג להלן. הדוגמה שלהלן מציגה את כל הפרמטרים שבאפשרותך לשלוח, אך אינך נדרש לשלוח את כולם (ראה טבלה למידע נוסף).

פרמטר תיאור
redirectroot (אופציונלי) הפניית בסיס כאשר מישהו מבקר בדומיין שלך
הפניה מחדש404 (אופציונלי) ניתוב מחדש מותאם אישית של 404
סלסול --מיקום --בקש לשים 'https://urlkai.com/api/domain/:id/update' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'PUT',
    'url': 'https://urlkai.com/api/domain/:id/update',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/domain/:id/update"
מטען = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("PUT", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": הדומיין עודכן בהצלחה.
} 
מחיקת דומיין
DELETE https://urlkai.com/api/domain/:id/delete

כדי למחוק דומיין, צריך לשלוח בקשת מחיקה.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "מחק",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'מחק',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/domain/:id/delete"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("DELETE", url, headers=headers, json=funload)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": "הדומיין נמחק בהצלחה."
} 

שכבות-על של CTA

רשימת שכבות-על של CTA
GET https://urlkai.com/api/overlay?limit=2&page=1

כדי לקבל שכבות-על של CTA דרך ה-API, אתה יכול להשתמש בנקודת קצה זו. באפשרותך גם לסנן נתונים (ראה טבלה לקבלת מידע נוסף).

פרמטר תיאור
גבול (אופציונלי) תוצאת נתונים לכל עמוד
דף (אופציונלי) בקשה לדף נוכחי
סלסול --מיקום --בקש קבל 'https://urlkai.com/api/overlay?limit=2&page=1' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'קבל',
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/overlay?limit=2&page=1"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("GET", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": "0",
    "data": {
        "תוצאה": 2,
        "perpage": 2,
        "Currentpage": 1,
        "העמוד הבא": 1,
        "MaxPage": 1,
        "cta": [
            {
                "id": 1,
                "type": "הודעה",
                "שם": "פרומו למוצר 1",
                "תאריך": 2020-11-10 18:00:00
            },
            {
                "id": 2,
                "type": "איש קשר",
                "name": "דף איש קשר",
                "תאריך": 2020-11-10 18:10:00
            }
        ]
    }
} 

קמפיינים

רשימות קמפיינים
GET https://urlkai.com/api/campaigns?limit=2&page=1

כדי להעביר את הקמפיינים שלך דרך ה-API, אתה יכול להשתמש בנקודת קצה זו. באפשרותך גם לסנן נתונים (ראה טבלה לקבלת מידע נוסף).

פרמטר תיאור
גבול (אופציונלי) תוצאת נתונים לכל עמוד
דף (אופציונלי) בקשה לדף נוכחי
סלסול --מיקום --בקש קבל 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'קבל',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("GET", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": "0",
    "data": {
        "תוצאה": 2,
        "perpage": 2,
        "Currentpage": 1,
        "העמוד הבא": 1,
        "MaxPage": 1,
        "קמפיינים": [
            {
                "id": 1,
                "name": "קמפיין לדוגמא",
                "ציבורי": לא נכון,
                "מסובב": לא נכון,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "קמפיין פייסבוק",
                "ציבורי": נכון,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": https:\/\/domain.com\/u\/admin\/test-2
            }
        ]
    }
} 
Create a Campaign
POST https://urlkai.com/api/campaign/add

ניתן להוסיף קמפיין באמצעות נקודת קצה זו.

פרמטר תיאור
שם (אופציונלי) שם הקמפיין
סלאג (אופציונלי) שבלול מסובב
ציבור (אופציונלי) גישה
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \
--data-raw '{
    "name": "קמפיין חדש",
    "slug": "מערכה חדשה",
    "ציבורי": נכון
}' 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "קמפיין חדש",
	    "slug": "מערכה חדשה",
	    "ציבורי": נכון
	}',
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/add',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: JSON.stringify({
    "name": "קמפיין חדש",
    "slug": "מערכה חדשה",
    "ציבורי": נכון
}),
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/campaign/add"
מטען = {
    "name": "קמפיין חדש",
    "slug": "מערכה חדשה",
    "ציבורי": נכון
}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("POST", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{
    "name": "קמפיין חדש",
    "slug": "מערכה חדשה",
    "ציבורי": נכון
}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "id": 3,
    "domain": "קמפיין חדש",
    "ציבורי": נכון,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

ניתן להקצות קישור קצר לקמפיין באמצעות נקודת קצה זו. נקודת הקצה דורשת את מזהה הקמפיין ואת מזהה הקישור הקצר.

סלסול --מיקום --בקש POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("POST", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": קישור נוסף לקמפיין בהצלחה.
} 
キャンペーンの更新
PUT https://urlkai.com/api/campaign/:id/update

כדי לעדכן קמפיין, עליך לשלוח נתונים חוקיים ב-JSON באמצעות בקשת PUT. יש לשלוח את הנתונים כגוף הגולמי של בקשתך כפי שמוצג להלן. הדוגמה שלהלן מציגה את כל הפרמטרים שבאפשרותך לשלוח, אך אינך נדרש לשלוח את כולם (ראה טבלה למידע נוסף).

פרמטר תיאור
שם (חובה) שם הקמפיין
סלאג (אופציונלי) שבלול מסובב
ציבור (אופציונלי) גישה
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \
--data-raw '{
    "name": "קמפיין טוויטר",
    "slug": "קמפיין טוויטר",
    "ציבורי": נכון
}' 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "קמפיין טוויטר",
	    "slug": "קמפיין טוויטר",
	    "ציבורי": נכון
	}',
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'PUT',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: JSON.stringify({
    "name": "קמפיין טוויטר",
    "slug": "קמפיין טוויטר",
    "ציבורי": נכון
}),
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/campaign/:id/update"
מטען = {
    "name": "קמפיין טוויטר",
    "slug": "קמפיין טוויטר",
    "ציבורי": נכון
}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("PUT", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{
    "name": "קמפיין טוויטר",
    "slug": "קמפיין טוויטר",
    "ציבורי": נכון
}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "id": 3,
    "domain": "קמפיין טוויטר",
    "ציבורי": נכון,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
מחיקת קמפיין
DELETE https://urlkai.com/api/campaign/:id/delete

כדי למחוק קמפיין, עליך לשלוח בקשת מחיקה.

curl --location --בקש למחוק 'https://urlkai.com/api/campaign/:id/delete' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "מחק",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'מחק',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/campaign/:id/delete"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("DELETE", url, headers=headers, json=funload)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": "הקמפיין נמחק בהצלחה."
} 

Custom Splash

רשימה התזה מותאמת אישית
GET https://urlkai.com/api/splash?limit=2&page=1

כדי לקבל דפי פתיחה מותאמים אישית דרך ה-API, אתה יכול להשתמש בנקודת קצה זו. באפשרותך גם לסנן נתונים (ראה טבלה לקבלת מידע נוסף).

פרמטר תיאור
גבול (אופציונלי) תוצאת נתונים לכל עמוד
דף (אופציונלי) בקשה לדף נוכחי
סלסול --מיקום --בקש קבל 'https://urlkai.com/api/splash?limit=2&page=1' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'קבל',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/splash?limit=2&page=1"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("GET", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": "0",
    "data": {
        "תוצאה": 2,
        "perpage": 2,
        "Currentpage": 1,
        "העמוד הבא": 1,
        "MaxPage": 1,
        "splash": [
            {
                "id": 1,
                "שם": "פרומו למוצר 1",
                "תאריך": 2020-11-10 18:00:00
            },
            {
                "id": 2,
                "שם": "פרומו מוצר 2",
                "תאריך": 2020-11-10 18:10:00
            }
        ]
    }
} 

קבצים

קבצי רשימה
GET https://urlkai.com/api/files?limit=2&page=1

קבל את כל הקבצים שלך. אתה יכול גם לחפש לפי שם.

פרמטר תיאור
שם (אופציונלי) חיפוש קובץ לפי שם
גבול (אופציונלי) תוצאת נתונים לכל עמוד
דף (אופציונלי) בקשה לדף נוכחי
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/files?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://urlkai.com/api/files?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);
});
import requests
url = "https://urlkai.com/api/files?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/files?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Server response
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/PzjYm",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/BnvDQ",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/oYPJC",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
העלאת קובץ
POST https://urlkai.com/api/files/upload/:filename?name=My+File

העלה קובץ על-ידי שליחת הנתונים הבינאריים כגוף הפרסום. עליך לשלוח את שם הקובץ כולל הסיומת במקום :filename בכתובת האתר (למשל brandkit.zip). באפשרותך להגדיר אפשרויות על-ידי שליחת הפרמטרים הבאים.

פרמטר תיאור
שם (אופציונלי) שם קובץ
מנהג (אופציונלי) כינוי מותאם אישית במקום כינוי אקראי.
תחום (אופציונלי) דומיין מותאם אישית
סיסמה (אופציונלי) הגנת סיסמה
תפוגה (אופציונלי) תפוגה עבור דוגמת ההורדה 2021-09-28
מקסימום הורדות (אופציונלי) מספר מרבי של הורדות
curl --location --request POST 'https://urlkai.com/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/files/upload/:filename?name=My+File",
    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 => 
        '"BINARY DATA"',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/files/upload/:filename?name=My+File',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify("BINARY DATA"),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
import requests
url = "https://urlkai.com/api/files/upload/:filename?name=My+File"
payload = "BINARY DATA"
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/files/upload/:filename?name=My+File");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent(""BINARY DATA"", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Server response
{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/urlkai.com\/UIBXT"
}

פיקסלים

רשימת פיקסלים
GET https://urlkai.com/api/pixels?limit=2&page=1

כדי לקבל את קודי הפיקסלים דרך ה-API, אתה יכול להשתמש בנקודת קצה זו. באפשרותך גם לסנן נתונים (ראה טבלה לקבלת מידע נוסף).

פרמטר תיאור
גבול (אופציונלי) תוצאת נתונים לכל עמוד
דף (אופציונלי) בקשה לדף נוכחי
סלסול --מיקום --בקש קבל 'https://urlkai.com/api/pixels?limit=2&page=1' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'קבל',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/pixels?limit=2&page=1"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("GET", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": "0",
    "data": {
        "תוצאה": 2,
        "perpage": 2,
        "Currentpage": 1,
        "העמוד הבא": 1,
        "MaxPage": 1,
        "פיקסלים": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM Pixel",
                "תגית": "GA-123456789",
                "תאריך": 2020-11-10 18:00:00
            },
            {
                "id": 2,
                "type": "twitterpixel",
                "name": "פיקסל טוויטר",
                "tag": "1234567",
                "תאריך": 2020-11-10 18:10:00
            }
        ]
    }
} 
יצירת פיקסל
POST https://urlkai.com/api/pixel/add

ניתן ליצור פיקסל באמצעות נקודת קצה זו. עליך לשלוח את סוג הפיקסל ואת התיוג.

פרמטר תיאור
סוג (נדרש) gtmpixel | גפיקסל | fbpixel | פיקסל אדוורדס | לינקדאין פיקסל | טוויטרפיקסל | adrollpixel | קורפיקסל | פינטרסט | בינג | סנאפצ'ט | רדיט | טיקטוק
שם (חובה) שם מותאם אישית לפיקסל
תג (חובה) התיוג של הפיקסל
סלסול --מיקום --בקש POST 'https://urlkai.com/api/pixel/add' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "ה-GTM שלי",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "gtmpixel",
	    "name": "ה-GTM שלי",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/pixel/add',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: JSON.stringify({
    "type": "gtmpixel",
    "name": "ה-GTM שלי",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/pixel/add"
מטען = {
    "type": "gtmpixel",
    "name": "ה-GTM שלי",
    "tag": "GTM-ABCDE"
}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("POST", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{
    "type": "gtmpixel",
    "name": "ה-GTM שלי",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "ID": 1
} 
ピクセルを更新する
PUT https://urlkai.com/api/pixel/:id/update

כדי לעדכן פיקסל, עליך לשלוח נתונים חוקיים ב-JSON באמצעות בקשת PUT. יש לשלוח את הנתונים כגוף הגולמי של בקשתך כפי שמוצג להלן. הדוגמה שלהלן מציגה את כל הפרמטרים שבאפשרותך לשלוח, אך אינך נדרש לשלוח את כולם (ראה טבלה למידע נוסף).

פרמטר תיאור
שם (אופציונלי) שם מותאם אישית לפיקסל
תג (חובה) התיוג של הפיקסל
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \
--data-raw '{
    "name": "ה-GTM שלי",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "ה-GTM שלי",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'PUT',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: JSON.stringify({
    "name": "ה-GTM שלי",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/pixel/:id/update"
מטען = {
    "name": "ה-GTM שלי",
    "tag": "GTM-ABCDE"
}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("PUT", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{
    "name": "ה-GTM שלי",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": הפיקסל עודכן בהצלחה.
} 
מחיקת פיקסל
DELETE https://urlkai.com/api/pixel/:id/delete

כדי למחוק פיקסל, עליך לשלוח בקשת מחיקה.

curl --location --request delete 'https://urlkai.com/api/pixel/:id/delete' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "מחק",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'מחק',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/pixel/:id/delete"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("DELETE", url, headers=headers, json=funload)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": "הפיקסל נמחק בהצלחה."
} 

QRコード

רשימת קודי QR
GET https://urlkai.com/api/qr?limit=2&page=1

כדי לקבל את קודי ה-QR שלך דרך ה-API, אתה יכול להשתמש בנקודת קצה זו. באפשרותך גם לסנן נתונים (ראה טבלה לקבלת מידע נוסף).

פרמטר תיאור
גבול (אופציונלי) תוצאת נתונים לכל עמוד
דף (אופציונלי) בקשה לדף נוכחי
סלסול --מיקום --בקש קבל 'https://urlkai.com/api/qr?limit=2&page=1' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'קבל',
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/qr?limit=2&page=1"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("GET", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": "0",
    "data": {
        "תוצאה": 2,
        "perpage": 2,
        "Currentpage": 1,
        "העמוד הבא": 1,
        "MaxPage": 1,
        "qrs": [
            {
                "id": 2,
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "סריקות": 0,
                "name": "Google",
                "תאריך": 2020-11-10 18:01:43
            },
            {
                "id": 1,
                "link": "https:\/\/urlkai.com\/qr\/b9edfe",
                "סריקות": 5,
                "name": "Google Canada",
                "date": "2020-11-10 18:00:25"
            }
        ]
    }
} 
קבל קוד QR יחיד
GET https://urlkai.com/api/qr/:id

כדי לקבל פרטים עבור קוד QR יחיד דרך ה-API, אתה יכול להשתמש בנקודת קצה זו.

סלסול --מיקום --בקש לקבל 'https://urlkai.com/api/qr/:id' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'קבל',
    'url': 'https://urlkai.com/api/qr/:id',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/qr/:id"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("GET", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "details": {
        "id": 1,
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "סריקות": 5,
        "name": "Google Canada",
        "date": "2020-11-10 18:00:25"
    },
    "data": {
        "קליקים": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "לא ידוע": "1"
        },
        "topReferrers": {
            "ישיר, דוא"ל ואחר": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "פייסבוק": 0,
            "טוויטר": 0,
            "אינסטגרם": 0
        }
    }
} 
צור קוד QR
POST https://urlkai.com/api/qr/add

כדי ליצור קוד QR, עליך לשלוח נתונים חוקיים ב-JSON באמצעות בקשת POST. יש לשלוח את הנתונים כגוף הגולמי של בקשתך כפי שמוצג להלן. הדוגמה שלהלן מציגה את כל הפרמטרים שבאפשרותך לשלוח, אך אינך נדרש לשלוח את כולם (ראה טבלה למידע נוסף).

פרמטר תיאור
סוג טקסט (חובה) | מניית vCard | קישור | דוא"ל | טלפון | סמס | WiFi
נתונים (חובה) נתונים שיוטמעו בתוך קוד ה-QR. הנתונים יכולים להיות מחרוזת או מערך בהתאם לסוג
רקע (אופציונלי) צבע RGB למשל RGB (255,255,255)
הקידמה (אופציונלי) צבע RGB, למשל rgb(0,0,0)
לוגו (אופציונלי) נתיב ללוגו png או jpg
שם (אופציונלי) שם קוד QR
סלסול --מיקום --בקש הודעה 'https://urlkai.com/api/qr/add' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \
--data-raw '{
    "type": "קישור",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": ממשק API של קוד QR
}' 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/qr/add",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "קישור",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "foreground": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": ממשק API של קוד QR
	}',
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/qr/add',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: JSON.stringify({
    "type": "קישור",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": ממשק API של קוד QR
}),
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/qr/add"
מטען = {
    "type": "קישור",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png",
    "name": ממשק API של קוד QR
}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("POST", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{
    "type": "קישור",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": ממשק API של קוד QR
}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "id": 3,
    "link": https:\/\/urlkai.com\/qr\/a58f79
} 
עדכן קוד QR
PUT https://urlkai.com/api/qr/:id/update

כדי לעדכן קוד QR, עליך לשלוח נתונים חוקיים ב-JSON באמצעות בקשת PUT. יש לשלוח את הנתונים כגוף הגולמי של בקשתך כפי שמוצג להלן. הדוגמה שלהלן מציגה את כל הפרמטרים שבאפשרותך לשלוח, אך אינך נדרש לשלוח את כולם (ראה טבלה למידע נוסף).

פרמטר תיאור
נתונים (חובה) נתונים שיוטמעו בתוך קוד ה-QR. הנתונים יכולים להיות מחרוזת או מערך בהתאם לסוג
רקע (אופציונלי) צבע RGB למשל RGB (255,255,255)
הקידמה (אופציונלי) צבע RGB, למשל rgb(0,0,0)
לוגו (אופציונלי) נתיב ללוגו png או jpg
סלסול --מיקום --בקש לשים 'https://urlkai.com/api/qr/:id/update' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \
--data-raw '{
    "type": "קישור",
    "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, מערך(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "קישור",
	    "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);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'PUT',
    'url': 'https://urlkai.com/api/qr/:id/update',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: JSON.stringify({
    "type": "קישור",
    "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) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/qr/:id/update"
מטען = {
    "type": "קישור",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("PUT", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{
    "type": "קישור",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": https:\/\/site.com\/logo.png
}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": "ה-QR עודכן בהצלחה."
} 
מחיקת קוד QR
DELETE https://urlkai.com/api/qr/:id/delete

כדי למחוק קוד QR, עליך לשלוח בקשת מחיקה.

curl --location --request delete 'https://urlkai.com/api/qr/:id/delete' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "מחק",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'מחק',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/qr/:id/delete"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("DELETE", url, headers=headers, json=funload)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": קוד QR נמחק בהצלחה.
} 

チャンネル一覧

רשימת ערוצים
GET https://urlkai.com/api/channels?limit=2&page=1

כדי לקבל את הערוצים שלך דרך ה-API, אתה יכול להשתמש בנקודת קצה זו. באפשרותך גם לסנן נתונים (ראה טבלה לקבלת מידע נוסף).

פרמטר תיאור
גבול (אופציונלי) תוצאת נתונים לכל עמוד
דף (אופציונלי) בקשה לדף נוכחי
סלסול --מיקום --בקש קבל 'https://urlkai.com/api/channels?limit=2&page=1' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'קבל',
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/channels?limit=2&page=1"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("GET", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": "0",
    "data": {
        "תוצאה": 2,
        "perpage": 2,
        "Currentpage": 1,
        "העמוד הבא": 1,
        "MaxPage": 1,
        "ערוצים": [
            {
                "id": 1,
                "name": "ערוץ 1",
                "description": "תיאור ערוץ 1",
                "צבע": "#000000",
                "Starred": נכון
            },
            {
                "id": 2,
                "name": "ערוץ 2",
                "description": "תיאור ערוץ 2",
                "color": "#FF0000",
                "Starred": לא נכון
            }
        ]
    }
} 
פריטי ערוץ רשימה
GET https://urlkai.com/api/channel/:id?limit=1&page=1

כדי לקבל פריטים בערוצים נבחרים דרך ה-API, אתה יכול להשתמש בנקודת קצה זו. באפשרותך גם לסנן נתונים (ראה טבלה לקבלת מידע נוסף).

פרמטר תיאור
גבול (אופציונלי) תוצאת נתונים לכל עמוד
דף (אופציונלי) בקשה לדף נוכחי
סלסול --מיקום --בקש קבל 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'קבל',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("GET", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": "0",
    "data": {
        "תוצאה": 2,
        "perpage": 2,
        "Currentpage": 1,
        "העמוד הבא": 1,
        "MaxPage": 1,
        "items": [
            {
                "type": "קישורים",
                "id": 1,
                "title": "הקישור לדוגמה שלי",
                "תצוגה מקדימה": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "תאריך": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "הביוגרפיה לדוגמה שלי",
                "תצוגה מקדימה": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "תאריך": "2022-06-01"
            }
        ]
    }
} 
Create a Channel
POST https://urlkai.com/api/channel/add

ניתן להוסיף ערוץ באמצעות נקודת קצה זו.

פרמטר תיאור
שם (חובה) שם הערוץ
תיאור (אופציונלי) תיאור הערוץ
צבע (אופציונלי) צבע תג ערוץ (HEX)
מסומן בכוכב (אופציונלי) סימון הערוץ בכוכב או לא (נכון או לא נכון)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \
--data-raw '{
    "name": "ערוץ חדש",
    "description": "הערוץ החדש שלי",
    "צבע": "#000000",
    "Starred": נכון
}' 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "ערוץ חדש",
	    "description": "הערוץ החדש שלי",
	    "צבע": "#000000",
	    "Starred": נכון
	}',
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/add',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: JSON.stringify({
    "name": "ערוץ חדש",
    "description": "הערוץ החדש שלי",
    "צבע": "#000000",
    "Starred": נכון
}),
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/channel/add"
מטען = {
    "name": "ערוץ חדש",
    "description": "הערוץ החדש שלי",
    "צבע": "#000000",
    "Starred": נכון
}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("POST", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{
    "name": "ערוץ חדש",
    "description": "הערוץ החדש שלי",
    "צבע": "#000000",
    "Starred": נכון
}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "id": 3,
    "name": "ערוץ חדש",
    "description": "הערוץ החדש שלי",
    "צבע": "#000000",
    "Starred": נכון
} 
הקצאת פריט לערוץ
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

ניתן להקצות פריט לכל ערוץ על ידי שליחת בקשה עם מזהה הערוץ, סוג הפריט (קישורים, ביו או qr) ומזהה הפריט.

פרמטר תיאור
ערוץ: (חובה) מזהה ערוץ
:סוג (חובה) קישורים או ביוגרפיה או QR
פריט: (חובה) מזהה פריט
סלסול --מיקום --בקש POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("POST", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": "הפריט נוסף בהצלחה לערוץ."
} 
Update Channel
PUT https://urlkai.com/api/channel/:id/update

כדי לעדכן ערוץ, עליך לשלוח נתונים חוקיים ב-JSON באמצעות בקשת PUT. יש לשלוח את הנתונים כגוף הגולמי של בקשתך כפי שמוצג להלן. הדוגמה שלהלן מציגה את כל הפרמטרים שבאפשרותך לשלוח, אך אינך נדרש לשלוח את כולם (ראה טבלה למידע נוסף).

פרמטר תיאור
שם (אופציונלי) שם הערוץ
תיאור (אופציונלי) תיאור הערוץ
צבע (אופציונלי) צבע תג ערוץ (HEX)
מסומן בכוכב (אופציונלי) סימון הערוץ בכוכב או לא (נכון או לא נכון)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "ערוץ לפריטים עבור Acme Corp",
    "color": "#FFFFFF",
    "Starred": לא נכון
}' 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Acme Corp",
	    "description": "ערוץ לפריטים עבור Acme Corp",
	    "color": "#FFFFFF",
	    "Starred": לא נכון
	}',
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'PUT',
    'url': 'https://urlkai.com/api/channel/:id/update',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    גוף: JSON.stringify({
    "name": "Acme Corp",
    "description": "ערוץ לפריטים עבור Acme Corp",
    "color": "#FFFFFF",
    "Starred": לא נכון
}),
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/channel/:id/update"
מטען = {
    "name": "Acme Corp",
    "description": "ערוץ לפריטים עבור Acme Corp",
    "color": "#FFFFFF",
    "Starred": לא נכון
}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("PUT", כתובת אתר, headers=headers, json=מטען)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{
    "name": "Acme Corp",
    "description": "ערוץ לפריטים עבור Acme Corp",
    "color": "#FFFFFF",
    "Starred": לא נכון
}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": הערוץ עודכן בהצלחה.
} 
מחק ערוץ
DELETE https://urlkai.com/api/channel/:id/delete

כדי למחוק ערוץ, עליך לשלוח בקשת מחיקה. כל הפריטים לא יוקצו גם כן.

curl --location --request delete 'https://urlkai.com/api/channel/:id/delete' \
--כותרת 'הרשאה: נושא YOURAPIKEY' \
--כותרת 'סוג תוכן: יישום/json' \ 
$curl = curl_init();

curl_setopt_array($curl, מערך(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => נכון,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => נכון,
    CURLOPT_CUSTOMREQUEST => "מחק",
    CURLOPT_HTTPHEADER => [
        "הרשאה: נושא YOURAPIKEY",
        "סוג תוכן: יישום/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
הד $response; 
var request = require('בקשה');
var options = {
    'שיטה': 'מחק',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'כותרות': {
        'הרשאה': 'נושא YOURAPIKEY',
        'סוג תוכן': 'יישום/json'
    },
    
};
request(options, function (error, response) {
    אם (שגיאה) לזרוק שגיאה חדשה (שגיאה);
    console.log(response.body);
}); 
בקשות ייבוא
url = "https://urlkai.com/api/channel/:id/delete"
תוכן מנה = {}
headers = {
    'הרשאה': 'נושא YOURAPIKEY',
    'סוג תוכן': 'יישום/json'
}
response = requests.request("DELETE", url, headers=headers, json=funload)
הדפסה(תגובה.טקסט) 
var client = חדש HttpClient();
var request = חדש HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
בקשה. headers.add("הרשאה", "נושא YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
בקשה. תוכן = תוכן;
var response = המתנה ללקוח. SendAsync (בקשה);
תגובה. EnsureSuccessStatusCode();
Console.WriteLine(המתן לתגובה. Content.ReadAsStringAsync()); 
Server response
{
    "שגיאה": 0,
    "message": הערוץ נמחק בהצלחה.
} 

リンク