เริ่มต้นใช้งาน ตรวจ สอบ ขีดจํากัดอัตรา การจัดการการตอบสนอง
บัญชี
โดเมนที่มีตราสินค้า
ภาพซ้อนทับ CTA
แคมเปญ
Custom Splash
แฟ้ม
พิก เซล
QRコード
チャンネル一覧
リンク

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

เริ่มต้นใช้งาน

ต้องใช้คีย์ API สําหรับคําขอที่ระบบจะดําเนินการ เมื่อผู้ใช้ลงทะเบียนแล้ว ระบบจะสร้างคีย์ API สําหรับผู้ใช้รายนี้โดยอัตโนมัติ ต้องส่งคีย์ API พร้อมกับคําขอแต่ละครั้ง (ดูตัวอย่างทั้งหมดด้านล่าง) หากไม่ได้ส่งคีย์ API หรือหมดอายุ จะเกิดข้อผิดพลาด โปรดตรวจสอบให้แน่ใจว่าได้เก็บคีย์ API ของคุณไว้เป็นความลับเพื่อป้องกันการละเมิด

ตรวจ สอบ

หากต้องการตรวจสอบสิทธิ์กับระบบ API คุณต้องส่งคีย์ API ของคุณเป็นโทเค็นการอนุญาตในแต่ละคําขอ คุณสามารถดูโค้ดตัวอย่างด้านล่าง

curl --location --request POST 'https://urlkai.com/api/account' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "โพสต์",
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
));

$response = curl_exec($curl); 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'วิธีการ': 'โพสต์',
    'url': 'https://urlkai.com/api/account',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    ร่างกาย: ''
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/account"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
  'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
  'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
ขีดจํากัดอัตรา

API ของเรามีตัวจํากัดอัตราเพื่อป้องกันคําขอที่เพิ่มขึ้นอย่างรวดเร็วเพื่อเพิ่มความเสถียรสูงสุด ขณะนี้ตัวจํากัดอัตราของเราจํากัดไว้ที่ 30 คําขอต่อ 1 นาที โปรดทราบว่าอัตราอาจเปลี่ยนแปลงได้ตามแผนการสมัครสมาชิก

ส่วนหัวหลายส่วนจะถูกส่งควบคู่ไปกับการตอบกลับ และสามารถตรวจสอบข้อมูลเหล่านี้เพื่อกําหนดข้อมูลต่างๆ เกี่ยวกับคําขอ

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
การจัดการการตอบสนอง

การตอบกลับ API ทั้งหมดจะถูกส่งคืนในรูปแบบ JSON ตามค่าเริ่มต้น ในการแปลงสิ่งนี้เป็นข้อมูลที่ใช้งานได้ จะต้องใช้ฟังก์ชันที่เหมาะสมตามภาษา ใน PHP สามารถใช้ฟังก์ชัน json_decode() เพื่อแปลงข้อมูลเป็นวัตถุ (ค่าเริ่มต้น) หรืออาร์เรย์ (ตั้งค่าพารามิเตอร์ที่สองเป็น true) การตรวจสอบคีย์ข้อผิดพลาดเป็นสิ่งสําคัญมากเนื่องจากให้ข้อมูลว่ามีข้อผิดพลาดหรือไม่ คุณยังสามารถตรวจสอบรหัสส่วนหัวได้อีกด้วย

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

บัญชี

รับบัญชี
GET https://urlkai.com/api/account

หากต้องการรับข้อมูลเกี่ยวกับบัญชี คุณสามารถส่งคําขอไปยังปลายทางนี้ และจะส่งคืนข้อมูลเกี่ยวกับบัญชี

curl --location --request รับ 'https://urlkai.com/api/account' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "รับ"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'รับ',
    'url': 'https://urlkai.com/api/account',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/account"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "ข้อมูล": {
        "รหัส": 1,
        "อีเมล": " [ป้องกันอีเมล] ",
        "ชื่อผู้ใช้": "sampleuser",
        "อวาตาร์": "https:\/\/domain.com\/content\/avatar.png",
        "สถานะ": "โปร",
        "หมดอายุ": "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' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/json' \
--data-raw '{
    "อีเมล": " [ป้องกันอีเมล] ",
    "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 => "ใส่"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "อีเมล": " [ป้องกันอีเมล] ",
	    "password": "รหัสผ่านใหม่"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'method': 'ใส่',
    'url': 'https://urlkai.com/api/account/update',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    เนื้อหา: JSON.stringify({
    "อีเมล": " [ป้องกันอีเมล] ",
    "password": "รหัสผ่านใหม่"
}),
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/account/update"
น้ําหนักบรรทุก = {
    "อีเมล": " [ป้องกันอีเมล] ",
    "password": "รหัสผ่านใหม่"
}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{
    "อีเมล": " [ป้องกันอีเมล] ",
    "password": "รหัสผ่านใหม่"
}", System.Text.Encoding.UTF8, "แอปพลิเคชัน/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "อัปเดตบัญชีสําเร็จแล้ว"
} 

โดเมนที่มีตราสินค้า

แสดงรายการโดเมนที่มีตราสินค้า
GET https://urlkai.com/api/domains?limit=2&page=1

หากต้องการรับโดเมนที่มีตราสินค้าผ่าน API คุณสามารถใช้ตําแหน่งข้อมูลนี้ได้ คุณยังสามารถกรองข้อมูลได้อีกด้วย (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
เขต (ไม่บังคับ) ผลลัพธ์ข้อมูลต่อหน้า
หน้า (ไม่บังคับ) คําขอหน้าปัจจุบัน
curl --location --request รับ 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "รับ"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'รับ',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/domains?limit=2&page=1"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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 = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": "0",
    "ข้อมูล": {
        "ผลลัพธ์": 2,
        "perpage": 2,
        "หน้าปัจจุบัน": 1,
        "หน้าถัดไป": 1,
        "แม็กซ์เพจ": 1,
        "โดเมน": [
            {
                "รหัส": 1,
                "โดเมน": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "รหัส": 2,
                "โดเมน": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
} 
สร้างโดเมนที่มีตราสินค้า
POST https://urlkai.com/api/domain/add

สามารถเพิ่มโดเมนได้โดยใช้ปลายทางนี้ โปรดตรวจสอบให้แน่ใจว่าโดเมนชี้ไปยังเซิร์ฟเวอร์ของเราอย่างถูกต้อง

พารามิเตอร์ คำอธิบาย
อาณาจักร (จําเป็น) โดเมนที่มีตราสินค้ารวมถึง http หรือ https
เปลี่ยนเส้นทางราก (ไม่บังคับ) การเปลี่ยนเส้นทางรูทเมื่อมีคนเข้าชมโดเมนของคุณ
เปลี่ยนเส้นทาง 404 (ไม่บังคับ) เปลี่ยนเส้นทาง 404 แบบกําหนดเอง
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/json' \
--data-raw '{
    "โดเมน": "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 => "โพสต์",
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "โดเมน": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'วิธีการ': 'โพสต์',
    'url': 'https://urlkai.com/api/domain/add',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    เนื้อหา: JSON.stringify({
    "โดเมน": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/domain/add"
น้ําหนักบรรทุก = {
    "โดเมน": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{
    "โดเมน": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "แอปพลิเคชัน/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "รหัส": 1
} 
ドメインを更新
PUT https://urlkai.com/api/domain/:id/update

หากต้องการอัปเดตโดเมนที่มีตราสินค้า คุณต้องส่งข้อมูลที่ถูกต้องในรูปแบบ JSON ผ่านคําขอ PUT ข้อมูลจะต้องถูกส่งเป็นเนื้อหาดิบของคําขอของคุณดังที่แสดงด้านล่าง ตัวอย่างด้านล่างแสดงพารามิเตอร์ทั้งหมดที่คุณสามารถส่งได้ แต่คุณไม่จําเป็นต้องส่งทั้งหมด (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
เปลี่ยนเส้นทางราก (ไม่บังคับ) การเปลี่ยนเส้นทางรูทเมื่อมีคนเข้าชมโดเมนของคุณ
เปลี่ยนเส้นทาง 404 (ไม่บังคับ) เปลี่ยนเส้นทาง 404 แบบกําหนดเอง
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "ใส่"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'method': 'ใส่',
    'url': 'https://urlkai.com/api/domain/:id/update',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    เนื้อหา: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/domain/:id/update"
น้ําหนักบรรทุก = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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, "แอปพลิเคชัน/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "อัปเดตโดเมนเรียบร้อยแล้ว"
} 
ลบโดเมน
DELETE https://urlkai.com/api/domain/:id/delete

หากต้องการลบโดเมน คุณต้องส่งคําขอ DELETE

curl --location -request ลบ 'https://urlkai.com/api/domain/:id/delete' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'ลบ',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/domain/:id/delete"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("ลบ", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "ลบโดเมนเรียบร้อยแล้ว"
} 

ภาพซ้อนทับ CTA

รายการซ้อนทับ CTA
GET https://urlkai.com/api/overlay?limit=2&page=1

หากต้องการรับการซ้อนทับ cta ผ่าน API คุณสามารถใช้ปลายทางนี้ได้ คุณยังสามารถกรองข้อมูลได้อีกด้วย (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
เขต (ไม่บังคับ) ผลลัพธ์ข้อมูลต่อหน้า
หน้า (ไม่บังคับ) คําขอหน้าปัจจุบัน
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "รับ"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'รับ',
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/overlay?limit=2&page=1"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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 = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": "0",
    "ข้อมูล": {
        "ผลลัพธ์": 2,
        "perpage": 2,
        "หน้าปัจจุบัน": 1,
        "หน้าถัดไป": 1,
        "แม็กซ์เพจ": 1,
        "cta": [
            {
                "รหัส": 1,
                "type": "ข้อความ",
                "name": "โปรโมชั่นสินค้า 1",
                "วันที่": "2020-11-10 18:00:00"
            },
            {
                "รหัส": 2,
                "type": "ติดต่อ",
                "name": "หน้าติดต่อ",
                "วันที่": "2020-11-10 18:10:00"
            }
        ]
    }
} 

แคมเปญ

รายการแคมเปญ
GET https://urlkai.com/api/campaigns?limit=2&page=1

หากต้องการรับแคมเปญผ่าน API คุณสามารถใช้ตําแหน่งข้อมูลนี้ได้ คุณยังสามารถกรองข้อมูลได้อีกด้วย (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
เขต (ไม่บังคับ) ผลลัพธ์ข้อมูลต่อหน้า
หน้า (ไม่บังคับ) คําขอหน้าปัจจุบัน
curl --location --request รับ 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "รับ"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'รับ',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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 = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": "0",
    "ข้อมูล": {
        "ผลลัพธ์": 2,
        "perpage": 2,
        "หน้าปัจจุบัน": 1,
        "หน้าถัดไป": 1,
        "แม็กซ์เพจ": 1,
        "แคมเปญ": [
            {
                "รหัส": 1,
                "name": "แคมเปญตัวอย่าง",
                "สาธารณะ": เท็จ,
                "rotator": เท็จ,
                "รายการ": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "รหัส": 2,
                "domain": "แคมเปญ Facebook",
                "สาธารณะ": จริง,
                "โรเตเตอร์": "https:\/\/domain.com\/r\/test",
                "รายการ": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
สร้างแคมเปญ
POST https://urlkai.com/api/campaign/add

สามารถเพิ่มแคมเปญได้โดยใช้ตําแหน่งข้อมูลนี้

พารามิเตอร์ คำอธิบาย
ชื่อ (ไม่บังคับ) ชื่อแคมเปญ
ทาก (ไม่บังคับ) ทากโรเตเตอร์
สาธารณะ (ไม่บังคับ) เข้าถึง
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "โพสต์",
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "แคมเปญใหม่",
	    "slug": "แคมเปญใหม่",
	    "สาธารณะ": จริง
	}',
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'วิธีการ': 'โพสต์',
    'url': 'https://urlkai.com/api/campaign/add',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    เนื้อหา: JSON.stringify({
    "name": "แคมเปญใหม่",
    "slug": "แคมเปญใหม่",
    "สาธารณะ": จริง
}),
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/campaign/add"
น้ําหนักบรรทุก = {
    "name": "แคมเปญใหม่",
    "slug": "แคมเปญใหม่",
    "สาธารณะ": จริง
}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{
    "name": "แคมเปญใหม่",
    "slug": "แคมเปญใหม่",
    "สาธารณะ": จริง
}", System.Text.Encoding.UTF8, "แอปพลิเคชัน/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "รหัส": 3,
    "domain": "แคมเปญใหม่",
    "สาธารณะ": จริง,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "รายการ": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

สามารถกําหนดลิงก์แบบสั้นให้กับแคมเปญได้โดยใช้ตําแหน่งข้อมูลนี้ ปลายทางต้องใช้รหัสแคมเปญและรหัสลิงก์สั้น

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "โพสต์",
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'วิธีการ': 'โพสต์',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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 = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "เพิ่มลิงก์ลงในแคมเปญเรียบร้อยแล้ว"
} 
キャンペーンの更新
PUT https://urlkai.com/api/campaign/:id/update

หากต้องการอัปเดตแคมเปญ คุณต้องส่งข้อมูลที่ถูกต้องในรูปแบบ JSON ผ่านคําขอ PUT ข้อมูลจะต้องถูกส่งเป็นเนื้อหาดิบของคําขอของคุณดังที่แสดงด้านล่าง ตัวอย่างด้านล่างแสดงพารามิเตอร์ทั้งหมดที่คุณสามารถส่งได้ แต่คุณไม่จําเป็นต้องส่งทั้งหมด (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
ชื่อ (จําเป็น) ชื่อแคมเปญ
ทาก (ไม่บังคับ) ทากโรเตเตอร์
สาธารณะ (ไม่บังคับ) เข้าถึง
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/json' \
--data-raw '{
    "name": "แคมเปญทวิตเตอร์",
    "ทาก": "แคมเปญทวิตเตอร์",
    "สาธารณะ": จริง
}' 
$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 => "ใส่"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "แคมเปญทวิตเตอร์",
	    "ทาก": "แคมเปญทวิตเตอร์",
	    "สาธารณะ": จริง
	}',
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'method': 'ใส่',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    เนื้อหา: JSON.stringify({
    "name": "แคมเปญทวิตเตอร์",
    "ทาก": "แคมเปญทวิตเตอร์",
    "สาธารณะ": จริง
}),
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/campaign/:id/update"
น้ําหนักบรรทุก = {
    "name": "แคมเปญทวิตเตอร์",
    "ทาก": "แคมเปญทวิตเตอร์",
    "สาธารณะ": จริง
}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{
    "name": "แคมเปญทวิตเตอร์",
    "ทาก": "แคมเปญทวิตเตอร์",
    "สาธารณะ": จริง
}", System.Text.Encoding.UTF8, "แอปพลิเคชัน/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "รหัส": 3,
    "domain": "แคมเปญทวิตเตอร์",
    "สาธารณะ": จริง,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "รายการ": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
ลบแคมเปญ
DELETE https://urlkai.com/api/campaign/:id/delete

หากต้องการลบแคมเปญ คุณต้องส่งคําขอ DELETE

curl --location --request ลบ 'https://urlkai.com/api/campaign/:id/delete' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'ลบ',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/campaign/:id/delete"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("ลบ", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "ลบแคมเปญเรียบร้อยแล้ว"
} 

Custom Splash

รายการ Custom Splash
GET https://urlkai.com/api/splash?limit=2&page=1

หากต้องการรับหน้าเริ่มต้นแบบกําหนดเองผ่าน API คุณสามารถใช้ปลายทางนี้ได้ คุณยังสามารถกรองข้อมูลได้อีกด้วย (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
เขต (ไม่บังคับ) ผลลัพธ์ข้อมูลต่อหน้า
หน้า (ไม่บังคับ) คําขอหน้าปัจจุบัน
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "รับ"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'รับ',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/splash?limit=2&page=1"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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 = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": "0",
    "ข้อมูล": {
        "ผลลัพธ์": 2,
        "perpage": 2,
        "หน้าปัจจุบัน": 1,
        "หน้าถัดไป": 1,
        "แม็กซ์เพจ": 1,
        "สาด": [
            {
                "รหัส": 1,
                "name": "โปรโมชั่นสินค้า 1",
                "วันที่": "2020-11-10 18:00:00"
            },
            {
                "รหัส": 2,
                "name": "โปรโมชั่นสินค้า 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());
การตอบสนองของเซิร์ฟเวอร์
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/OFPZH",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/itMhX",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/XDorm",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
อัปโหลดไฟล์
POST https://urlkai.com/api/files/upload/:filename?name=My+File

อัปโหลดไฟล์โดยส่งข้อมูลไบนารีเป็นเนื้อหาโพสต์ คุณต้องส่งชื่อไฟล์ที่มีนามสกุลแทน :filename ใน URL (เช่น 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());
การตอบสนองของเซิร์ฟเวอร์
{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/urlkai.com\/cUAdd"
}

พิก เซล

รายการพิกเซล
GET https://urlkai.com/api/pixels?limit=2&page=1

หากต้องการรับรหัสพิกเซลผ่าน API คุณสามารถใช้ปลายทางนี้ได้ คุณยังสามารถกรองข้อมูลได้อีกด้วย (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
เขต (ไม่บังคับ) ผลลัพธ์ข้อมูลต่อหน้า
หน้า (ไม่บังคับ) คําขอหน้าปัจจุบัน
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "รับ"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'รับ',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/pixels?limit=2&page=1"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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 = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": "0",
    "ข้อมูล": {
        "ผลลัพธ์": 2,
        "perpage": 2,
        "หน้าปัจจุบัน": 1,
        "หน้าถัดไป": 1,
        "แม็กซ์เพจ": 1,
        "พิกเซล": [
            {
                "รหัส": 1,
                "ประเภท": "gtmpixel",
                "name": "พิกเซล GTM",
                "แท็ก": "GA-123456789",
                "วันที่": "2020-11-10 18:00:00"
            },
            {
                "รหัส": 2,
                "type": "twitterpixel",
                "name": "พิกเซลของทวิตเตอร์",
                "แท็ก": "1234567",
                "วันที่": "2020-11-10 18:10:00"
            }
        ]
    }
} 
สร้างพิกเซล
POST https://urlkai.com/api/pixel/add

สามารถสร้างพิกเซลได้โดยใช้ตําแหน่งข้อมูลนี้ คุณต้องส่งประเภทพิกเซลและแท็ก

พารามิเตอร์ คำอธิบาย
ประเภท (จําเป็น) gtmpixel | gtmpixel กาพิกเซล | FBPIXEL | FBPIXEL AdWords พิกเซล | AdWordsPixel LinkedInPixel | LinkedIn TwitterPixel | ทวิตเตอร์พิกเซล AdrollPixel | AdrollPixel ควอราพิกเซล | Pinterest | Bing | สแน็ปแชท | Snapchat เรดดิต | ติ๊กต๊อก
ชื่อ (จําเป็น) ชื่อที่กําหนดเองสําหรับพิกเซลของคุณ
ฉลาก (จําเป็น) แท็กสําหรับพิกเซล
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/json' \
--data-raw '{
    "ประเภท": "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 => "โพสต์",
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "ประเภท": "gtmpixel",
	    "name": "GTM ของฉัน",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'วิธีการ': 'โพสต์',
    'url': 'https://urlkai.com/api/pixel/add',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    เนื้อหา: JSON.stringify({
    "ประเภท": "gtmpixel",
    "name": "GTM ของฉัน",
    "tag": "GTM-ABCDE"
}),
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/pixel/add"
น้ําหนักบรรทุก = {
    "ประเภท": "gtmpixel",
    "name": "GTM ของฉัน",
    "tag": "GTM-ABCDE"
}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{
    "ประเภท": "gtmpixel",
    "name": "GTM ของฉัน",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "แอปพลิเคชัน/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "รหัส": 1
} 
ピクセルを更新する
PUT https://urlkai.com/api/pixel/:id/update

หากต้องการอัปเดตพิกเซล คุณต้องส่งข้อมูลที่ถูกต้องในรูปแบบ JSON ผ่านคําขอ PUT ข้อมูลจะต้องถูกส่งเป็นเนื้อหาดิบของคําขอของคุณดังที่แสดงด้านล่าง ตัวอย่างด้านล่างแสดงพารามิเตอร์ทั้งหมดที่คุณสามารถส่งได้ แต่คุณไม่จําเป็นต้องส่งทั้งหมด (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
ชื่อ (ไม่บังคับ) ชื่อที่กําหนดเองสําหรับพิกเซลของคุณ
ฉลาก (จําเป็น) แท็กสําหรับพิกเซล
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "ใส่"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "GTM ของฉัน",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'method': 'ใส่',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    เนื้อหา: JSON.stringify({
    "name": "GTM ของฉัน",
    "tag": "GTM-ABCDE"
}),
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/pixel/:id/update"
น้ําหนักบรรทุก = {
    "name": "GTM ของฉัน",
    "tag": "GTM-ABCDE"
}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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, "แอปพลิเคชัน/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "อัปเดตพิกเซลเรียบร้อยแล้ว"
} 
ลบพิกเซล
DELETE https://urlkai.com/api/pixel/:id/delete

หากต้องการลบพิกเซล คุณต้องส่งคําขอลบ

curl --location -request ลบ 'https://urlkai.com/api/pixel/:id/delete' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'ลบ',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/pixel/:id/delete"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("ลบ", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "ลบพิกเซลเรียบร้อยแล้ว"
} 

QRコード

แสดงรายการรหัส QR
GET https://urlkai.com/api/qr?limit=2&page=1

หากต้องการรับรหัส QR ของคุณผ่าน API คุณสามารถใช้ปลายทางนี้ได้ คุณยังสามารถกรองข้อมูลได้อีกด้วย (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
เขต (ไม่บังคับ) ผลลัพธ์ข้อมูลต่อหน้า
หน้า (ไม่บังคับ) คําขอหน้าปัจจุบัน
curl --location --request รับ 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "รับ"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'รับ',
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/qr?limit=2&page=1"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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 = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": "0",
    "ข้อมูล": {
        "ผลลัพธ์": 2,
        "perpage": 2,
        "หน้าปัจจุบัน": 1,
        "หน้าถัดไป": 1,
        "แม็กซ์เพจ": 1,
        "คิวอาร์ส": [
            {
                "รหัส": 2,
                "ลิงค์": "https:\/\/urlkai.com\/QR\/A2D5E",
                "สแกน": 0,
                "name": "Google",
                "วันที่": "2020-11-10 18:01:43"
            },
            {
                "รหัส": 1,
                "ลิงค์": "https:\/\/urlkai.com\/QR\/B9EDFE",
                "สแกน": 5,
                "name": "กูเกิลแคนาดา",
                "วันที่": "2020-11-10 18:00:25"
            }
        ]
    }
} 
รับรหัส QR เดียว
GET https://urlkai.com/api/qr/:id

หากต้องการรับรายละเอียดสําหรับรหัส QR เดียวผ่าน API คุณสามารถใช้ปลายทางนี้ได้

curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "รับ"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'รับ',
    'url': 'https://urlkai.com/api/qr/:id',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/qr/:id"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "รายละเอียด": {
        "รหัส": 1,
        "ลิงค์": "https:\/\/urlkai.com\/QR\/B9EDFE",
        "สแกน": 5,
        "name": "กูเกิลแคนาดา",
        "วันที่": "2020-11-10 18:00:25"
    },
    "ข้อมูล": {
        "คลิก": 1,
        "คลิกซ้ํา": 1,
        "topCountries": {
            "ไม่ทราบ": "1"
        },
        "top ผู้อ้างอิง": {
            "โดยตรง อีเมล และอื่นๆ": "1"
        },
        "topBrowsers": {
            "โครเมี่ยม": "1"
        },
        "ท็อปออส": {
            "หน้าต่าง 10": "1"
        },
        "โซเชียลนับ": {
            "เฟสบุ๊ค": 0,
            "ทวิตเตอร์": 0,
            "อินสตาแกรม": 0
        }
    }
} 
สร้างรหัส QR
POST https://urlkai.com/api/qr/add

ในการสร้างรหัส QR คุณต้องส่งข้อมูลที่ถูกต้องในรูปแบบ JSON ผ่านคําขอ POST ข้อมูลจะต้องถูกส่งเป็นเนื้อหาดิบของคําขอของคุณดังที่แสดงด้านล่าง ตัวอย่างด้านล่างแสดงพารามิเตอร์ทั้งหมดที่คุณสามารถส่งได้ แต่คุณไม่จําเป็นต้องส่งทั้งหมด (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
ประเภท ข้อความ (จําเป็น) | วีการ์ด | ลิงค์ | อีเมล | โทรศัพท์ | SMS | อินเตอร์เน็ตไร้สาย
ข้อมูล (จําเป็น) ข้อมูลที่จะฝังไว้ในคิวอาร์โค้ด ข้อมูลสามารถเป็นสตริงหรืออาร์เรย์ขึ้นอยู่กับประเภท
พื้นหลัง (ไม่บังคับ) สี RGB เช่น rgb (255,255,255)
เบื้องหน้า (ไม่บังคับ) สี RGB เช่น rgb(0,0,0)
โลโก้ (ไม่บังคับ) เส้นทางไปยังโลโก้ png หรือ jpg
ชื่อ (ไม่บังคับ) ชื่อคิวอาร์โค้ด
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/json' \
--data-raw '{
    "type": "ลิงค์",
    "ข้อมูล": "https:\/\/google.com",
    "พื้นหลัง": "rgb(255,255,255)",
    "เบื้องหน้า": "rgb(0,0,0)",
    "โลโก้": "https:\/\/site.com\/logo.png",
    "name": "คิวอาร์โค้ด API"
}' 
$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 => "โพสต์",
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "ลิงค์",
	    "ข้อมูล": "https:\/\/google.com",
	    "พื้นหลัง": "rgb(255,255,255)",
	    "เบื้องหน้า": "rgb(0,0,0)",
	    "โลโก้": "https:\/\/site.com\/logo.png",
	    "name": "คิวอาร์โค้ด API"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'วิธีการ': 'โพสต์',
    'url': 'https://urlkai.com/api/qr/add',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    เนื้อหา: JSON.stringify({
    "type": "ลิงค์",
    "ข้อมูล": "https:\/\/google.com",
    "พื้นหลัง": "rgb(255,255,255)",
    "เบื้องหน้า": "rgb(0,0,0)",
    "โลโก้": "https:\/\/site.com\/logo.png",
    "name": "คิวอาร์โค้ด API"
}),
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/qr/add"
น้ําหนักบรรทุก = {
    "type": "ลิงค์",
    "data": "https://google.com",
    "พื้นหลัง": "rgb(255,255,255)",
    "เบื้องหน้า": "rgb(0,0,0)",
    "โลโก้": "https://site.com/logo.png",
    "name": "คิวอาร์โค้ด API"
}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{
    "type": "ลิงค์",
    "ข้อมูล": "https:\/\/google.com",
    "พื้นหลัง": "rgb(255,255,255)",
    "เบื้องหน้า": "rgb(0,0,0)",
    "โลโก้": "https:\/\/site.com\/logo.png",
    "name": "คิวอาร์โค้ด API"
}", System.Text.Encoding.UTF8, "แอปพลิเคชัน/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "รหัส": 3,
    "ลิงค์": "https:\/\/urlkai.com\/QR\/A58F79"
} 
อัปเดตรหัส QR
PUT https://urlkai.com/api/qr/:id/update

ในการอัปเดตรหัส QR คุณต้องส่งข้อมูลที่ถูกต้องในรูปแบบ JSON ผ่านคําขอ PUT ข้อมูลจะต้องถูกส่งเป็นเนื้อหาดิบของคําขอของคุณดังที่แสดงด้านล่าง ตัวอย่างด้านล่างแสดงพารามิเตอร์ทั้งหมดที่คุณสามารถส่งได้ แต่คุณไม่จําเป็นต้องส่งทั้งหมด (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
ข้อมูล (จําเป็น) ข้อมูลที่จะฝังไว้ในคิวอาร์โค้ด ข้อมูลสามารถเป็นสตริงหรืออาร์เรย์ขึ้นอยู่กับประเภท
พื้นหลัง (ไม่บังคับ) สี RGB เช่น rgb (255,255,255)
เบื้องหน้า (ไม่บังคับ) สี RGB เช่น rgb(0,0,0)
โลโก้ (ไม่บังคับ) เส้นทางไปยังโลโก้ png หรือ jpg
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/json' \
--data-raw '{
    "type": "ลิงค์",
    "ข้อมูล": "https:\/\/google.com",
    "พื้นหลัง": "rgb(255,255,255)",
    "เบื้องหน้า": "rgb(0,0,0)",
    "โลโก้": "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 => "ใส่"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "ลิงค์",
	    "ข้อมูล": "https:\/\/google.com",
	    "พื้นหลัง": "rgb(255,255,255)",
	    "เบื้องหน้า": "rgb(0,0,0)",
	    "โลโก้": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'method': 'ใส่',
    'url': 'https://urlkai.com/api/qr/:id/update',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    เนื้อหา: JSON.stringify({
    "type": "ลิงค์",
    "ข้อมูล": "https:\/\/google.com",
    "พื้นหลัง": "rgb(255,255,255)",
    "เบื้องหน้า": "rgb(0,0,0)",
    "โลโก้": "https:\/\/site.com\/logo.png"
}),
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/qr/:id/update"
น้ําหนักบรรทุก = {
    "type": "ลิงค์",
    "data": "https://google.com",
    "พื้นหลัง": "rgb(255,255,255)",
    "เบื้องหน้า": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{
    "type": "ลิงค์",
    "ข้อมูล": "https:\/\/google.com",
    "พื้นหลัง": "rgb(255,255,255)",
    "เบื้องหน้า": "rgb(0,0,0)",
    "โลโก้": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "แอปพลิเคชัน/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "QR ได้รับการอัปเดตเรียบร้อยแล้ว"
} 
ลบรหัส QR
DELETE https://urlkai.com/api/qr/:id/delete

หากต้องการลบรหัส QR คุณต้องส่งคําขอลบ

curl --location -request ลบ 'https://urlkai.com/api/qr/:id/delete' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'ลบ',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/qr/:id/delete"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("ลบ", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "ลบรหัส QR เรียบร้อยแล้ว"
} 

チャンネル一覧

รายการช่อง
GET https://urlkai.com/api/channels?limit=2&page=1

หากต้องการรับช่องผ่าน API คุณสามารถใช้ปลายทางนี้ได้ คุณยังสามารถกรองข้อมูลได้อีกด้วย (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
เขต (ไม่บังคับ) ผลลัพธ์ข้อมูลต่อหน้า
หน้า (ไม่บังคับ) คําขอหน้าปัจจุบัน
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "รับ"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'รับ',
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/channels?limit=2&page=1"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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 = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": "0",
    "ข้อมูล": {
        "ผลลัพธ์": 2,
        "perpage": 2,
        "หน้าปัจจุบัน": 1,
        "หน้าถัดไป": 1,
        "แม็กซ์เพจ": 1,
        "ช่อง": [
            {
                "รหัส": 1,
                "name": "ช่อง 1",
                "description": "คําอธิบายของช่อง 1",
                "สี": "#000000",
                "ติดดาว": จริง
            },
            {
                "รหัส": 2,
                "name": "ช่อง 2",
                "description": "คําอธิบายของช่อง 2",
                "color": "#FF0000",
                "ติดดาว": เท็จ
            }
        ]
    }
} 
รายการช่อง
GET https://urlkai.com/api/channel/:id?limit=1&page=1

หากต้องการรับรายการในช่องทางที่เลือกผ่าน API คุณสามารถใช้ปลายทางนี้ได้ คุณยังสามารถกรองข้อมูลได้อีกด้วย (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
เขต (ไม่บังคับ) ผลลัพธ์ข้อมูลต่อหน้า
หน้า (ไม่บังคับ) คําขอหน้าปัจจุบัน
curl --location --request รับ 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "รับ"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'รับ',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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 = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": "0",
    "ข้อมูล": {
        "ผลลัพธ์": 2,
        "perpage": 2,
        "หน้าปัจจุบัน": 1,
        "หน้าถัดไป": 1,
        "แม็กซ์เพจ": 1,
        "รายการ": [
            {
                "type": "ลิงก์",
                "รหัส": 1,
                "title": "ลิงค์ตัวอย่างของฉัน",
                "preview": "https:\/\/google.com",
                "ลิงค์": "https:\/\/urlkai.com\/google",
                "วันที่": "2022-05-12"
            },
            {
                "ประเภท": "ชีวภาพ",
                "รหัส": 1,
                "title": "ชีวประวัติตัวอย่างของฉัน",
                "preview": "https:\/\/urlkai.com\/mybio",
                "ลิงค์": "https:\/\/urlkai.com\/mybio",
                "วันที่": "2022-06-01"
            }
        ]
    }
} 
สร้างช่อง
POST https://urlkai.com/api/channel/add

สามารถเพิ่มช่องทางได้โดยใช้ปลายทางนี้

พารามิเตอร์ คำอธิบาย
ชื่อ (จําเป็น) ชื่อช่อง
คำอธิบาย (ไม่บังคับ) คําอธิบายช่อง
สี (ไม่บังคับ) สีป้ายช่อง (HEX)
ติดดาว (ไม่บังคับ) ติดดาวช่องหรือไม่ (จริงหรือเท็จ)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/json' \
--data-raw '{
    "name": "ช่องใหม่",
    "description": "ช่องใหม่ของฉัน",
    "สี": "#000000",
    "ติดดาว": จริง
}' 
$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 => "โพสต์",
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "ช่องใหม่",
	    "description": "ช่องใหม่ของฉัน",
	    "สี": "#000000",
	    "ติดดาว": จริง
	}',
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'วิธีการ': 'โพสต์',
    'url': 'https://urlkai.com/api/channel/add',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    เนื้อหา: JSON.stringify({
    "name": "ช่องใหม่",
    "description": "ช่องใหม่ของฉัน",
    "สี": "#000000",
    "ติดดาว": จริง
}),
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/channel/add"
น้ําหนักบรรทุก = {
    "name": "ช่องใหม่",
    "description": "ช่องใหม่ของฉัน",
    "สี": "#000000",
    "ติดดาว": จริง
}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{
    "name": "ช่องใหม่",
    "description": "ช่องใหม่ของฉัน",
    "สี": "#000000",
    "ติดดาว": จริง
}", System.Text.Encoding.UTF8, "แอปพลิเคชัน/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "รหัส": 3,
    "name": "ช่องใหม่",
    "description": "ช่องใหม่ของฉัน",
    "สี": "#000000",
    "ติดดาว": จริง
} 
กําหนดรายการให้กับช่องทาง
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

สามารถกําหนดรายการให้กับช่องทางใดก็ได้โดยการส่งคําขอพร้อมรหัสช่อง ประเภทรายการ (ลิงก์ ชีวภาพ หรือ qr) และรหัสรายการ

พารามิเตอร์ คำอธิบาย
:channelid (จําเป็น) รหัสช่อง
:ประเภท (ต้อง) ลิงก์หรือชีวประวัติหรือ QR
:รายการ ID (จําเป็น) รหัสรายการ
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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 => "โพสต์",
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'วิธีการ': 'โพสต์',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ 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 = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "เพิ่มรายการลงในช่องเรียบร้อยแล้ว"
} 
อัปเดตช่องทาง
PUT https://urlkai.com/api/channel/:id/update

หากต้องการอัปเดตช่องทาง คุณต้องส่งข้อมูลที่ถูกต้องในรูปแบบ JSON ผ่านคําขอ PUT ข้อมูลจะต้องถูกส่งเป็นเนื้อหาดิบของคําขอของคุณดังที่แสดงด้านล่าง ตัวอย่างด้านล่างแสดงพารามิเตอร์ทั้งหมดที่คุณสามารถส่งได้ แต่คุณไม่จําเป็นต้องส่งทั้งหมด (ดูตารางสําหรับข้อมูลเพิ่มเติม)

พารามิเตอร์ คำอธิบาย
ชื่อ (ไม่บังคับ) ชื่อช่อง
คำอธิบาย (ไม่บังคับ) คําอธิบายช่อง
สี (ไม่บังคับ) สีป้ายช่อง (HEX)
ติดดาว (ไม่บังคับ) ติดดาวช่องหรือไม่ (จริงหรือเท็จ)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "ช่องสําหรับรายการสําหรับ Acme Corp",
    "สี": "#FFFFFF",
    "ติดดาว": เท็จ
}' 
$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 => "ใส่"
    CURLOPT_HTTPHEADER => [
        "การอนุญาต: ผู้ถือ YOURAPIKEY",
        "ประเภทเนื้อหา: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Acme Corp",
	    "description": "ช่องสําหรับรายการสําหรับ Acme Corp",
	    "สี": "#FFFFFF",
	    "ติดดาว": เท็จ
	}',
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'method': 'ใส่',
    'url': 'https://urlkai.com/api/channel/:id/update',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    เนื้อหา: JSON.stringify({
    "name": "Acme Corp",
    "description": "ช่องสําหรับรายการสําหรับ Acme Corp",
    "สี": "#FFFFFF",
    "ติดดาว": เท็จ
}),
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/channel/:id/update"
น้ําหนักบรรทุก = {
    "name": "Acme Corp",
    "description": "ช่องสําหรับรายการสําหรับ Acme Corp",
    "สี": "#FFFFFF",
    "ติดดาว": เท็จ
}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{
    "name": "Acme Corp",
    "description": "ช่องสําหรับรายการสําหรับ Acme Corp",
    "สี": "#FFFFFF",
    "ติดดาว": เท็จ
}", System.Text.Encoding.UTF8, "แอปพลิเคชัน/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "อัปเดตช่องสําเร็จแล้ว"
} 
ลบช่อง
DELETE https://urlkai.com/api/channel/:id/delete

หากต้องการลบช่อง คุณต้องส่งคําขอ DELETE รายการทั้งหมดจะถูกยกเลิกการกําหนดเช่นกัน

curl --location --request ลบ 'https://urlkai.com/api/channel/:id/delete' \
--header 'การอนุญาต: ผู้ถือ YOURAPIKEY' \
--header 'ประเภทเนื้อหา: application/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",
        "ประเภทเนื้อหา: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
เสียงสะท้อน$response; 
คําขอ var = require('คําขอ');
ตัวเลือก var = {
    'เมธอด': 'ลบ',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'ส่วนหัว': {
        'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
        'ประเภทเนื้อหา': 'application/json'
    },
    
};
request(ตัวเลือก, ฟังก์ชัน (ข้อผิดพลาด, การตอบสนอง) {
    ถ้า (ข้อผิดพลาด) โยน ใหม่ Error(error);
    console.log(ตอบสนอง.ร่างกาย);
}); 
คําขอนําเข้า
url = "https://urlkai.com/api/channel/:id/delete"
น้ําหนักบรรทุก = {}
ส่วนหัว = {
    'การอนุญาต': 'ผู้ถือ YOURAPIKEY',
    'ประเภทเนื้อหา': 'application/json'
}
response = requests.request("ลบ", url, headers=headers, json=เพย์โหลด)
พิมพ์(response.text) 
var ไคลเอ็นต์ = ใหม่ HttpClient();
คําขอ var = ใหม่ HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
ขอร้อง  Headers.Add("การอนุญาต", "ผู้ถือ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
ขอร้อง  เนื้อหา = เนื้อหา;
การตอบสนอง var = รอไคลเอ็นต์ SendAsync(คําขอ);
การตอบสนอง  EnsureSuccessStatusCode();
Console.WriteLine(รอการตอบกลับ Content.ReadAsStringAsync()); 
การตอบสนองของเซิร์ฟเวอร์
{
    "ข้อผิดพลาด": 0,
    "message": "ลบช่องเรียบร้อยแล้ว"
} 

リンク