Geliştiriciler için API Referansı

Başlarken

İsteklerin sistem tarafından işlenmesi için bir API anahtarı gereklidir. Bir kullanıcı kaydolduğunda, bu kullanıcı için otomatik olarak bir API anahtarı oluşturulur. API anahtarı her istekle birlikte gönderilmelidir (aşağıdaki tam örneğe bakın). API anahtarı gönderilmezse veya süresi dolmuşsa bir hata olacaktır. Kötüye kullanımı önlemek için lütfen API anahtarınızı gizli tuttuğunuzdan emin olun.

kimlik doğrulama

API sistemiyle kimlik doğrulaması yapmak için API anahtarınızı her istekle birlikte bir yetkilendirme belirteci olarak göndermeniz gerekir. Aşağıda örnek kodu görebilirsiniz.

curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "SIARAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
));

$response = curl_exec($curl); 
var request = require('request');
var pilihan = {
    'kaedah': 'POS',
    'url': 'https://urlkai.com/api/account',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: ''
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/account"
muatan = {}
tajuk = {
  'Kebenaran': 'Pembawa YOURAPIKEY',
  'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Oran Sınırı

API'miz, kararlılığını en üst düzeye çıkarmak için isteklerdeki ani artışlara karşı koruma sağlayan bir hız sınırlayıcıya sahiptir. Hız sınırlayıcımız şu anda 1 dakika başına 30 istekle sınırlandırılmıştır. Sila ambil perhatian bahawa kadar mungkin berubah mengikut pelan yang dilanggan.

Yanıtın yanında birkaç başlık gönderilir ve bunlar istekle ilgili çeşitli bilgileri belirlemek için incelenebilir.

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Yanıt İşleme

Tüm API yanıtı, varsayılan olarak JSON biçiminde döndürülür. Bunu kullanılabilir verilere dönüştürmek için dile göre uygun işlevin kullanılması gerekecektir. PHP'de, json_decode() işlevi, verileri bir nesneye (varsayılan) veya bir diziye (ikinci parametreyi true olarak ayarlayın) dönüştürmek için kullanılabilir. Hata anahtarının kontrol edilmesi bir hata olup olmadığı hakkında bilgi verdiği için çok önemlidir. Başlık kodunu da kontrol edebilirsiniz.

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

Bağlantılar


CTA Yer Paylaşımları

Senaraikan Tindanan CTA
GET https://urlkai.com/api/overlay?limit=2&page=1

Untuk mendapatkan tindanan cta melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "DAPATKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'DAPATKAN',
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/overlay?limit=2&page=1"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": "0",
    "data": {
        "keputusan": 2,
        "perpage": 2,
        "currentpage": 1,
        "halaman seterusnya": 1,
        "maxpage": 1,
        "cta": [
            {
                "id": 1,
                "taip": "mesej",
                "name": "Promosi Produk 1",
                "tarikh": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "jenis": "kenalan",
                "name": "Halaman Hubungan",
                "tarikh": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Hesap

Hesap Al
GET https://urlkai.com/api/account

Hesapla ilgili bilgi almak için bu uç noktaya bir istek gönderebilirsiniz ve bu, hesapla ilgili verileri döndürür.

curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "DAPATKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'DAPATKAN',
    'url': 'https://urlkai.com/api/account',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/account"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "data": {
        "id": 1,
        "e-mel": " [e-mel dilindungi] ",
        "nama pengguna": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "tamat tempoh": "2022-11-15 15:00:00",
        "berdaftar": "2020-11-10 18:01:43"
    }
} 
Hesabı güncelle
PUT https://urlkai.com/api/account/update

Hesapla ilgili bilgileri güncellemek için bu uç noktaya bir istek gönderebilirsiniz; Bu, hesaptaki verileri güncelleyecektir.

curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "e-mel": " [e-mel dilindungi] ",
    "kata laluan": "kata laluan baru"
}' 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "LETAKKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "e-mel": " [e-mel dilindungi] ",
	    "kata laluan": "kata laluan baru"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'PUT',
    'url': 'https://urlkai.com/api/account/update',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: JSON.stringify({
    "e-mel": " [e-mel dilindungi] ",
    "kata laluan": "kata laluan baru"
}),
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/account/update"
muatan = {
    "e-mel": " [e-mel dilindungi] ",
    "kata laluan": "kata laluan baru"
}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{
    "e-mel": " [e-mel dilindungi] ",
    "kata laluan": "kata laluan baru"
}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "message": "Akaun telah berjaya dikemas kini."
} 

Kanallar

Senarai Saluran
GET https://urlkai.com/api/channels?limit=2&page=1

Untuk mendapatkan saluran anda melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "DAPATKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'DAPATKAN',
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/channels?limit=2&page=1"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": "0",
    "data": {
        "keputusan": 2,
        "perpage": 2,
        "currentpage": 1,
        "halaman seterusnya": 1,
        "maxpage": 1,
        "saluran": [
            {
                "id": 1,
                "name": "Saluran 1",
                "description": "Penerangan saluran 1",
                "warna": "#000000",
                "Berbintang": Benar
            },
            {
                "id": 2,
                "nama": "Saluran 2",
                "description": "Penerangan saluran 2",
                "warna": "#FF0000",
                "berbintang": palsu
            }
        ]
    }
} 
Senaraikan Item Saluran
GET https://urlkai.com/api/channel/:id?limit=1&page=1

Untuk mendapatkan item dalam saluran terpilih melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "DAPATKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'DAPATKAN',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": "0",
    "data": {
        "keputusan": 2,
        "perpage": 2,
        "currentpage": 1,
        "halaman seterusnya": 1,
        "maxpage": 1,
        "item": [
            {
                "jenis": "pautan",
                "id": 1,
                "title": "Pautan Sampel Saya",
                "pratonton": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "tarikh": "2022-05-12"
            },
            {
                "jenis": "bio",
                "id": 1,
                "title": "Bio Sampel Saya",
                "pratonton": "https:\/\/urlkai.com\/mybio",
                "pautan": "https:\/\/urlkai.com\/mybio",
                "tarikh": "2022-06-01"
            }
        ]
    }
} 
Kanal Oluştur
POST https://urlkai.com/api/channel/add

Saluran boleh ditambah menggunakan titik akhir ini.

Parameter Açıklama
Nama (diperlukan) Nama saluran
Keterangan (pilihan) Penerangan saluran
Warna (pilihan) Warna lencana saluran (HEX)
dibintangi (pilihan) Bintang saluran atau tidak (benar atau palsu)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Saluran Baru",
    "penerangan": "saluran baharu saya",
    "warna": "#000000",
    "Berbintang": Benar
}' 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "SIARAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Saluran Baru",
	    "penerangan": "saluran baharu saya",
	    "warna": "#000000",
	    "Berbintang": Benar
	}',
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'POS',
    'url': 'https://urlkai.com/api/channel/add',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: JSON.stringify({
    "name": "Saluran Baru",
    "penerangan": "saluran baharu saya",
    "warna": "#000000",
    "Berbintang": Benar
}),
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/channel/add"
muatan = {
    "name": "Saluran Baru",
    "penerangan": "saluran baharu saya",
    "warna": "#000000",
    "Berbintang": Benar
}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{
    "name": "Saluran Baru",
    "penerangan": "saluran baharu saya",
    "warna": "#000000",
    "Berbintang": Benar
}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "id": 3,
    "name": "Saluran Baru",
    "penerangan": "saluran baharu saya",
    "warna": "#000000",
    "Berbintang": Benar
} 
Tetapkan Item ke Saluran
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Item boleh diberikan kepada mana-mana saluran dengan menghantar permintaan dengan id saluran, jenis item (pautan, bio atau qr) dan id item.

Parameter Açıklama
:channelid (diperlukan) ID Saluran
:Jenis (Diperlukan) pautan atau bio atau QR
:itemid (diperlukan) Item ID
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "SIARAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'POS',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "message": "Item berjaya ditambahkan pada saluran."
} 
Kanalı Güncelle
PUT https://urlkai.com/api/channel/:id/update

Untuk mengemas kini saluran, anda perlu menghantar data yang sah dalam JSON melalui permintaan PUT. Data mesti dihantar sebagai badan mentah permintaan anda seperti yang ditunjukkan di bawah. Contoh di bawah menunjukkan semua parameter yang boleh anda hantar tetapi anda tidak perlu menghantar semua (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
Nama (pilihan) Nama saluran
Keterangan (pilihan) Penerangan saluran
Warna (pilihan) Warna lencana saluran (HEX)
dibintangi (pilihan) Bintang saluran atau tidak (benar atau palsu)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nama": "Acme Corp",
    "penerangan": "saluran untuk item untuk Acme Corp",
    "warna": "#FFFFFF",
    "berbintang": palsu
}' 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "LETAKKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "nama": "Acme Corp",
	    "penerangan": "saluran untuk item untuk Acme Corp",
	    "warna": "#FFFFFF",
	    "berbintang": palsu
	}',
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'PUT',
    'url': 'https://urlkai.com/api/channel/:id/update',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: JSON.stringify({
    "nama": "Acme Corp",
    "penerangan": "saluran untuk item untuk Acme Corp",
    "warna": "#FFFFFF",
    "berbintang": palsu
}),
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/channel/:id/update"
muatan = {
    "nama": "Acme Corp",
    "penerangan": "saluran untuk item untuk Acme Corp",
    "warna": "#FFFFFF",
    "berbintang": palsu
}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{
    "nama": "Acme Corp",
    "penerangan": "saluran untuk item untuk Acme Corp",
    "warna": "#FFFFFF",
    "berbintang": palsu
}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "message": "Saluran telah berjaya dikemas kini."
} 
Padam Saluran
DELETE https://urlkai.com/api/channel/:id/delete

Untuk memadamkan saluran, anda perlu menghantar permintaan DELETE. Semua item juga tidak akan ditugaskan.

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "PADAM",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'PADAM',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/channel/:id/delete"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "message": "Saluran telah berjaya dipadamkan."
} 

Markalı Alan Adları

Senaraikan Domain Berjenama
GET https://urlkai.com/api/domains?limit=2&page=1

Untuk mendapatkan domain berjenama anda melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "DAPATKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'DAPATKAN',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/domains?limit=2&page=1"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": "0",
    "data": {
        "keputusan": 2,
        "perpage": 2,
        "currentpage": 1,
        "halaman seterusnya": 1,
        "maxpage": 1,
        "domain": [
            {
                "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"
            }
        ]
    }
} 
Buat Domain Berjenama
POST https://urlkai.com/api/domain/add

Domain boleh ditambah menggunakan titik akhir ini. Sila pastikan domain dihalakan dengan betul ke pelayan kami.

Parameter Açıklama
Domain (diperlukan) Domain berjenama termasuk http atau https
redirectroot (pilihan) Ubah hala akar apabila seseorang melawat domain anda
lencongan404 (pilihan) Lencongan 404 tersuai
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/domain/add",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "SIARAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "domain": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'POS',
    'url': 'https://urlkai.com/api/domain/add',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: JSON.stringify({
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/domain/add"
muatan = {
    "domain": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "ID": 1
} 
Alan Adını Güncelle
PUT https://urlkai.com/api/domain/:id/update

Untuk mengemas kini domain berjenama, anda perlu menghantar data yang sah dalam JSON melalui permintaan PUT. Data mesti dihantar sebagai badan mentah permintaan anda seperti yang ditunjukkan di bawah. Contoh di bawah menunjukkan semua parameter yang boleh anda hantar tetapi anda tidak perlu menghantar semua (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
redirectroot (pilihan) Ubah hala akar apabila seseorang melawat domain anda
lencongan404 (pilihan) Lencongan 404 tersuai
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "LETAKKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'PUT',
    'url': 'https://urlkai.com/api/domain/:id/update',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/domain/:id/update"
muatan = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "message": "Domain telah berjaya dikemas kini."
} 
Padamkan Domain
DELETE https://urlkai.com/api/domain/:id/delete

Untuk memadamkan domain, anda perlu menghantar permintaan DELETE.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "PADAM",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'PADAM',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/domain/:id/delete"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "message": "Domain telah berjaya dipadamkan."
} 

Piksel

Senarai Piksel
GET https://urlkai.com/api/pixels?limit=2&page=1

Untuk mendapatkan kod piksel anda melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "DAPATKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'DAPATKAN',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/pixels?limit=2&page=1"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": "0",
    "data": {
        "keputusan": 2,
        "perpage": 2,
        "currentpage": 1,
        "halaman seterusnya": 1,
        "maxpage": 1,
        "piksel": [
            {
                "id": 1,
                "jenis": "gtmpixel",
                "nama": "GTM Pixel",
                "tag": "GA-123456789",
                "tarikh": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "jenis": "twitterpixel",
                "name": "Twitter Pixel",
                "tag": "1234567",
                "tarikh": "2020-11-10 18:10:00"
            }
        ]
    }
} 
Cipta piksel
POST https://urlkai.com/api/pixel/add

Piksel boleh dibuat menggunakan titik akhir ini. Anda perlu menghantar jenis piksel dan tag.

Parameter Açıklama
Jenis (diperlukan) gtmpixel | Gapixel | fbpixel | AdwordsPixel | LinkedInInPixel | Piksel Twitter | adrollpixel | Quorapixel | Pinterest | Bing | Snapchat | Reddit | TikTok
Nama (diperlukan) Nama tersuai untuk piksel anda
tag (diperlukan) Tag untuk piksel
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jenis": "gtmpixel",
    "nama": "GTM saya",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "SIARAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "jenis": "gtmpixel",
	    "nama": "GTM saya",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'POS',
    'url': 'https://urlkai.com/api/pixel/add',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: JSON.stringify({
    "jenis": "gtmpixel",
    "nama": "GTM saya",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/pixel/add"
muatan = {
    "jenis": "gtmpixel",
    "nama": "GTM saya",
    "tag": "GTM-ABCDE"
}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{
    "jenis": "gtmpixel",
    "nama": "GTM saya",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "ID": 1
} 
Pixel'i Güncelle
PUT https://urlkai.com/api/pixel/:id/update

Untuk mengemas kini piksel, anda perlu menghantar data yang sah dalam JSON melalui permintaan PUT. Data mesti dihantar sebagai badan mentah permintaan anda seperti yang ditunjukkan di bawah. Contoh di bawah menunjukkan semua parameter yang boleh anda hantar tetapi anda tidak perlu menghantar semua (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
Nama (pilihan) Nama tersuai untuk piksel anda
tag (diperlukan) Tag untuk piksel
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nama": "GTM saya",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "LETAKKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "nama": "GTM saya",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'PUT',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: JSON.stringify({
    "nama": "GTM saya",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/pixel/:id/update"
muatan = {
    "nama": "GTM saya",
    "tag": "GTM-ABCDE"
}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{
    "nama": "GTM saya",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "message": "Pixel telah berjaya dikemas kini."
} 
Padamkan Piksel
DELETE https://urlkai.com/api/pixel/:id/delete

Untuk memadamkan piksel, anda perlu menghantar permintaan DELETE.

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "PADAM",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'PADAM',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/pixel/:id/delete"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "message": "Pixel telah berjaya dipadamkan."
} 

QR Kodları

Senaraikan kod QR
GET https://urlkai.com/api/qr?limit=2&page=1

API üzerinden QR kodlarınızı almak için bu uç noktayı kullanabilirsiniz. Ayrıca verileri filtreleyebilirsiniz (Daha fazla bilgi için tabloya bakın).

Parameter Açıklama
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "DAPATKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'DAPATKAN',
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/qr?limit=2&page=1"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": "0",
    "data": {
        "keputusan": 2,
        "perpage": 2,
        "currentpage": 1,
        "halaman seterusnya": 1,
        "maxpage": 1,
        "qrs": [
            {
                "id": 2,
                "pautan": "https:\/\/urlkai.com\/qr\/a2d5e",
                "imbasan": 0,
                "name": "Google",
                "tarikh": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "pautan": "https:\/\/urlkai.com\/qr\/b9edfe",
                "imbasan": 5,
                "name": "Google Kanada",
                "tarikh": "2020-11-10 18:00:25"
            }
        ]
    }
} 
Tek bir QR Kodu alın
GET https://urlkai.com/api/qr/:id

API aracılığıyla tek bir QR kodunun ayrıntılarını almak için bu uç noktayı kullanabilirsiniz.

curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "DAPATKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'DAPATKAN',
    'url': 'https://urlkai.com/api/qr/:id',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/qr/:id"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "butiran": {
        "id": 1,
        "pautan": "https:\/\/urlkai.com\/qr\/b9edfe",
        "imbasan": 5,
        "name": "Google Kanada",
        "tarikh": "2020-11-10 18:00:25"
    },
    "data": {
        "klik": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Tidak diketahui": "1"
        },
        "perujuk atas": {
            "Langsung, e-mel dan lain-lain": "1"
        },
        "topBrowsers": {
            "Krom": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "facebook": 0,
            "twitter": 0,
            "Instagram": 0
        }
    }
} 
QR Kodu Oluşturun
POST https://urlkai.com/api/qr/add

Untuk membuat Kod QR, anda perlu menghantar data yang sah dalam JSON melalui permintaan POST. Data mesti dihantar sebagai badan mentah permintaan anda seperti yang ditunjukkan di bawah. Contoh di bawah menunjukkan semua parameter yang boleh anda hantar tetapi anda tidak perlu menghantar semua (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
Jenis Teks (diperlukan) | vcard | pautan | E-mel | Telefon | SMS | Wifi
Data (diperlukan) Data untuk dibenamkan di dalam kod QR. Data boleh menjadi rentetan atau tatasusunan bergantung pada jenis
Latar belakang (pilihan) Warna RGB cth rgb (255,255,255)
latar depan (pilihan) Warna RGB cth rgb (0,0,0)
Logo (pilihan) Laluan ke logo sama ada png atau jpg
Nama (pilihan) Nama kod QR
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jenis": "pautan",
    "data": "https:\/\/google.com",
    "latar belakang": "rgb(255,255,255)",
    "latar depan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API Kod QR"
}' 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/qr/add",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "SIARAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "jenis": "pautan",
	    "data": "https:\/\/google.com",
	    "latar belakang": "rgb(255,255,255)",
	    "latar depan": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": "API Kod QR"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'POS',
    'url': 'https://urlkai.com/api/qr/add',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: JSON.stringify({
    "jenis": "pautan",
    "data": "https:\/\/google.com",
    "latar belakang": "rgb(255,255,255)",
    "latar depan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API Kod QR"
}),
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/qr/add"
muatan = {
    "jenis": "pautan",
    "data": "https://google.com",
    "latar belakang": "rgb(255,255,255)",
    "latar depan": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png",
    "name": "API Kod QR"
}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{
    "jenis": "pautan",
    "data": "https:\/\/google.com",
    "latar belakang": "rgb(255,255,255)",
    "latar depan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API Kod QR"
}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "id": 3,
    "pautan": "https:\/\/urlkai.com\/qr\/a58f79"
} 
Kemas kini Kod QR
PUT https://urlkai.com/api/qr/:id/update

Bir QR Kodunu güncellemek için, bir PUT isteği aracılığıyla JSON'da geçerli bir veri göndermeniz gerekir. Veriler, aşağıda gösterildiği gibi isteğinizin ham gövdesi olarak gönderilmelidir. Aşağıdaki örnek, gönderebileceğiniz tüm parametreleri gösterir, ancak hepsini göndermeniz gerekmez (Daha fazla bilgi için tabloya bakın).

Parameter Açıklama
Data (diperlukan) Data untuk dibenamkan di dalam kod QR. Data boleh menjadi rentetan atau tatasusunan bergantung pada jenis
Latar belakang (pilihan) Warna RGB cth rgb (255,255,255)
latar depan (pilihan) Warna RGB cth rgb (0,0,0)
Logo (pilihan) Laluan ke logo sama ada png atau jpg
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jenis": "pautan",
    "data": "https:\/\/google.com",
    "latar belakang": "rgb(255,255,255)",
    "latar depan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}' 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "LETAKKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "jenis": "pautan",
	    "data": "https:\/\/google.com",
	    "latar belakang": "rgb(255,255,255)",
	    "latar depan": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'PUT',
    'url': 'https://urlkai.com/api/qr/:id/update',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: JSON.stringify({
    "jenis": "pautan",
    "data": "https:\/\/google.com",
    "latar belakang": "rgb(255,255,255)",
    "latar depan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/qr/:id/update"
muatan = {
    "jenis": "pautan",
    "data": "https://google.com",
    "latar belakang": "rgb(255,255,255)",
    "latar depan": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{
    "jenis": "pautan",
    "data": "https:\/\/google.com",
    "latar belakang": "rgb(255,255,255)",
    "latar depan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "message": "QR telah berjaya dikemas kini."
} 
QR Kodunu Sil
DELETE https://urlkai.com/api/qr/:id/delete

Bir QR kodunu silmek için bir DELETE isteği göndermeniz gerekir.

curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "PADAM",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'PADAM',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/qr/:id/delete"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "mesej": "Kod QR telah berjaya dipadamkan."
} 

Kampanyalar

Kempen Senarai
GET https://urlkai.com/api/campaigns?limit=2&page=1

Untuk mendapatkan kempen anda melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "DAPATKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'DAPATKAN',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": "0",
    "data": {
        "keputusan": 2,
        "perpage": 2,
        "currentpage": 1,
        "halaman seterusnya": 1,
        "maxpage": 1,
        "kempen": [
            {
                "id": 1,
                "name": "Kempen Sampel",
                "awam": palsu,
                "pemutar": palsu,
                "senarai": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Kempen Facebook",
                "awam": benar,
                "rotator": "https:\/\/domain.com\/r\/ujian",
                "senarai": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
Kampanya Oluştur
POST https://urlkai.com/api/campaign/add

Kempen boleh ditambah menggunakan titik akhir ini.

Parameter Açıklama
Nama (pilihan) Nama kempen
siput (pilihan) Siput Rotator
Awam (pilihan) Akses
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Kempen Baru",
    "slug": "kempen baru",
    "awam": benar
}' 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "SIARAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Kempen Baru",
	    "slug": "kempen baru",
	    "awam": benar
	}',
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'POS',
    'url': 'https://urlkai.com/api/campaign/add',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: JSON.stringify({
    "name": "Kempen Baru",
    "slug": "kempen baru",
    "awam": benar
}),
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/campaign/add"
muatan = {
    "name": "Kempen Baru",
    "slug": "kempen baru",
    "awam": benar
}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{
    "name": "Kempen Baru",
    "slug": "kempen baru",
    "awam": benar
}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "id": 3,
    "domain": "Kempen Baharu",
    "awam": benar,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "senarai": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Pautan pendek boleh diperuntukkan kepada kempen menggunakan titik akhir ini. Titik akhir memerlukan ID kempen dan ID pautan pendek.

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "SIARAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'POS',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "message": "Pautan berjaya ditambahkan pada kempen."
} 
Kampanyayı Güncelle
PUT https://urlkai.com/api/campaign/:id/update

Untuk mengemas kini kempen, anda perlu menghantar data yang sah dalam JSON melalui permintaan PUT. Data mesti dihantar sebagai badan mentah permintaan anda seperti yang ditunjukkan di bawah. Contoh di bawah menunjukkan semua parameter yang boleh anda hantar tetapi anda tidak perlu menghantar semua (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
Nama (diperlukan) Nama kempen
siput (pilihan) Siput Rotator
Awam (pilihan) Akses
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Kempen Twitter",
    "slug": "kempen twitter",
    "awam": benar
}' 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "LETAKKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Kempen Twitter",
	    "slug": "kempen twitter",
	    "awam": benar
	}',
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'PUT',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    badan: JSON.stringify({
    "name": "Kempen Twitter",
    "slug": "kempen twitter",
    "awam": benar
}),
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/campaign/:id/update"
muatan = {
    "name": "Kempen Twitter",
    "slug": "kempen twitter",
    "awam": benar
}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{
    "name": "Kempen Twitter",
    "slug": "kempen twitter",
    "awam": benar
}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "id": 3,
    "domain": "Kempen Twitter",
    "awam": benar,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "senarai": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
Padamkan Kempen
DELETE https://urlkai.com/api/campaign/:id/delete

Untuk memadamkan kempen, anda perlu menghantar permintaan DELETE.

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "PADAM",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'PADAM',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/campaign/:id/delete"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": 0,
    "message": "Kempen telah berjaya dipadamkan."
} 

Percikan Özel

Senarai Percikan Tersuai
GET https://urlkai.com/api/splash?limit=2&page=1

Untuk mendapatkan halaman percikan tersuai melalui API, anda boleh menggunakan titik akhir ini. Anda juga boleh menapis data (Lihat jadual untuk maklumat lanjut).

Parameter Açıklama
Had (pilihan) Hasil data setiap halaman
Laman (pilihan) Permintaan halaman semasa
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Kebenaran: Pembawa YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tatasusunan(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => benar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => benar,
    CURLOPT_CUSTOMREQUEST => "DAPATKAN",
    CURLOPT_HTTPHEADER => [
        "Kebenaran: Pembawa YOURAPIKEY",
        "Jenis Kandungan: aplikasi/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
gema $response; 
var request = require('request');
var pilihan = {
    'kaedah': 'DAPATKAN',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'pengepala': {
        'Kebenaran': 'Pembawa YOURAPIKEY',
        'Jenis-Kandungan': 'aplikasi/json'
    },
    
};
request(options, function (error, response) {
    jika (ralat) membuang Ralat baharu (ralat);
    console.log(tindak balas.badan);
}); 
Permintaan import
url = "https://urlkai.com/api/splash?limit=2&page=1"
muatan = {}
tajuk = {
    'Kebenaran': 'Pembawa YOURAPIKEY',
    'Jenis-Kandungan': 'aplikasi/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
cetak(respons.teks) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
Permintaan. Headers.Add("Kebenaran", "Pembawa YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
Permintaan. Kandungan = kandungan;
respons var = tunggu pelanggan. SendAsync(permintaan);
Respons. EnsureSuccessStatusCode();
Console.WriteLine(tunggu respons. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "ralat": "0",
    "data": {
        "keputusan": 2,
        "perpage": 2,
        "currentpage": 1,
        "halaman seterusnya": 1,
        "maxpage": 1,
        "percikan": [
            {
                "id": 1,
                "name": "Promosi Produk 1",
                "tarikh": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Promosi Produk 2",
                "tarikh": "2020-11-10 18:10:00"
            }
        ]
    }
}