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 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PRÍSPEVOK",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
));

$response = curl_exec($curl); 
var request = require('požiadavka');
var options = {
    "metóda": "POST",
    "url": "https://urlkai.com/api/account",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    Telo: ''
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/account"
užitočné zaťaženie = {}
hlavičky = {
  "Autorizácia": "Nositeľ YOURAPIKEY",
  'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. 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. Upozorňujeme, že cena sa môže meniť v závislosti od predplateného plánu.

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ı

Zoznam prekrytí CTA
GET https://urlkai.com/api/overlay?limit=2&page=1

Ak chcete získať prekrytia cta prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZÍSKAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'GET',
    "url": "https://urlkai.com/api/overlay?limit=2&page=1",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/overlay?limit=2&page=1"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "error": "0",
    "údaje": {
        "výsledok": 2,
        "perpage": 2,
        "aktuálna stránka": 1,
        "ďalšia strana": 1,
        "maxpage": 1,
        "CTA": [
            {
                "id": 1,
                "type": "správa",
                "name": "Promo produkt 1",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "kontakt",
                "name": "Kontaktná stránka",
                "date": "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 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZÍSKAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'GET',
    "url": "https://urlkai.com/api/account",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/account"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "údaje": {
        "id": 1,
        "e-mail": " [chránené e-mailom] ",
        "username": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "vyprší": "2022-11-15 15:00:00",
        "registrovaný": "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 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "e-mail": " [chránené e-mailom] ",
    "password": "nové heslo"
}' 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "e-mail": " [chránené e-mailom] ",
	    "password": "nové heslo"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "PUT",
    "url": "https://urlkai.com/api/account/update",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    body: JSON.stringify({
    "e-mail": " [chránené e-mailom] ",
    "password": "nové heslo"
}),
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/account/update"
užitočné zaťaženie = {
    "e-mail": " [chránené e-mailom] ",
    "password": "nové heslo"
}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{
    "e-mail": " [chránené e-mailom] ",
    "password": "nové heslo"
}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "Účet bol úspešne aktualizovaný."
} 

Kanálár

Zoznam kanálov
GET https://urlkai.com/api/channels?limit=2&page=1

Ak chcete získať svoje kanály prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZÍSKAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'GET',
    "url": "https://urlkai.com/api/channels?limit=2&page=1",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/channels?limit=2&page=1"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "error": "0",
    "údaje": {
        "výsledok": 2,
        "perpage": 2,
        "aktuálna stránka": 1,
        "ďalšia strana": 1,
        "maxpage": 1,
        "kanály": [
            {
                "id": 1,
                "name": "Kanál 1",
                "description": "Popis kanála 1",
                "color": "#000000",
                "Hviezdička": Pravda
            },
            {
                "id": 2,
                "name": "Kanál 2",
                "description": "Popis kanála 2",
                "color": "#FF0000",
                "Starred": False
            }
        ]
    }
} 
Zoznam položiek kanála
GET https://urlkai.com/api/channel/:id?limit=1&page=1

Ak chcete získať položky vo vybraných kanáloch prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZÍSKAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'GET',
    "url": "https://urlkai.com/api/channel/:id?limit=1&page=1",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "error": "0",
    "údaje": {
        "výsledok": 2,
        "perpage": 2,
        "aktuálna stránka": 1,
        "ďalšia strana": 1,
        "maxpage": 1,
        "položky": [
            {
                "type": "odkazy",
                "id": 1,
                "title": "Môj vzorový odkaz",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "dátum": "2022-05-12"
            },
            {
                "typ": "bio",
                "id": 1,
                "title": "Môj vzorový životopis",
                "preview": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "dátum": "2022-06-01"
            }
        ]
    }
} 
Kanál Oluştur
POST https://urlkai.com/api/channel/add

Kanál je možné pridať pomocou tohto koncového bodu.

Parametre Açıklama
meno (povinné) Názov kanála
popis (voliteľné) Popis kanála
farba (voliteľné) Farba odznaku kanála (HEX)
Hral (voliteľné) Kanál označte hviezdičkou alebo nie (pravda alebo nepravda)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nový kanál",
    "description": "môj nový kanál",
    "color": "#000000",
    "Hviezdička": Pravda
}' 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PRÍSPEVOK",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Nový kanál",
	    "description": "môj nový kanál",
	    "color": "#000000",
	    "Hviezdička": Pravda
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "POST",
    "url": "https://urlkai.com/api/channel/add",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Nový kanál",
    "description": "môj nový kanál",
    "color": "#000000",
    "Hviezdička": Pravda
}),
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/channel/add"
užitočné zaťaženie = {
    "name": "Nový kanál",
    "description": "môj nový kanál",
    "color": "#000000",
    "Hviezdička": Pravda
}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{
    "name": "Nový kanál",
    "description": "môj nový kanál",
    "color": "#000000",
    "Hviezdička": Pravda
}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "id": 3,
    "name": "Nový kanál",
    "description": "môj nový kanál",
    "color": "#000000",
    "Hviezdička": Pravda
} 
Priradenie položky ku kanálu
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Položku je možné priradiť k ľubovoľnému kanálu odoslaním požiadavky s ID kanála, typom položky (odkazy, bio alebo qr) a ID položky.

Parametre Açıklama
:identifikátor kanála (povinné) Identifikácia kanála
:typ (povinné) odkazy alebo životopis alebo QR
:itemid (povinné) ID položky
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PRÍSPEVOK",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "POST",
    "url": "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "Položka bola úspešne pridaná do kanála."
} 
Kanalı Güncelle
PUT https://urlkai.com/api/channel/:id/update

Ak chcete aktualizovať kanál, musíte odoslať platné údaje vo formáte JSON prostredníctvom požiadavky PUT. Údaje musia byť odoslané ako nespracované telo vašej žiadosti, ako je uvedené nižšie. V nasledujúcom príklade sú uvedené všetky parametre, ktoré môžete odoslať, ale nemusíte odoslať všetky (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
meno (voliteľné) Názov kanála
popis (voliteľné) Popis kanála
farba (voliteľné) Farba odznaku kanála (HEX)
Hral (voliteľné) Kanál označte hviezdičkou alebo nie (pravda alebo nepravda)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "kanál pre položky pre Acme Corp",
    "color": "#FFFFFF",
    "Starred": False
}' 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Acme Corp",
	    "description": "kanál pre položky pre Acme Corp",
	    "color": "#FFFFFF",
	    "Starred": False
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "PUT",
    "url": "https://urlkai.com/api/channel/:id/update",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Acme Corp",
    "description": "kanál pre položky pre Acme Corp",
    "color": "#FFFFFF",
    "Starred": False
}),
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/channel/:id/update"
užitočné zaťaženie = {
    "name": "Acme Corp",
    "description": "kanál pre položky pre Acme Corp",
    "color": "#FFFFFF",
    "Starred": False
}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{
    "name": "Acme Corp",
    "description": "kanál pre položky pre Acme Corp",
    "color": "#FFFFFF",
    "Starred": False
}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "Kanál bol úspešne aktualizovaný."
} 
Odstrániť kanál
DELETE https://urlkai.com/api/channel/:id/delete

Ak chcete kanál odstrániť, musíte odoslať žiadosť o odstránenie. Všetky položky budú tiež nepriradené.

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

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZMAZAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'DELETE',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/channel/:id/delete"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "Kanál bol úspešne odstránený."
} 

Markalı Alan Adları

Zoznam značkových domén
GET https://urlkai.com/api/domains?limit=2&page=1

Ak chcete získať svoje značkové domény prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZÍSKAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'GET',
    "url": "https://urlkai.com/api/domains?limit=2&page=1",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/domains?limit=2&page=1"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "error": "0",
    "údaje": {
        "výsledok": 2,
        "perpage": 2,
        "aktuálna stránka": 1,
        "ďalšia strana": 1,
        "maxpage": 1,
        "domény": [
            {
                "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"
            }
        ]
    }
} 
Vytvorenie značkovej domény
POST https://urlkai.com/api/domain/add

Pomocou tohto koncového bodu je možné pridať doménu. Uistite sa, že doména je správne nasmerovaná na náš server.

Parametre Açıklama
doména (povinné) Značková doména vrátane http alebo https
Redirectroot (voliteľné) Koreňové presmerovanie, keď niekto navštívi vašu doménu
presmerovanie404 (voliteľné) Vlastné presmerovanie 404
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Autorizácia: Nositeľ 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, pole(
    CURLOPT_URL => "https://urlkai.com/api/domain/add",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PRÍSPEVOK",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "domain": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "POST",
    "url": "https://urlkai.com/api/domain/add",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    body: JSON.stringify({
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/domain/add"
užitočné zaťaženie = {
    "domain": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "id": 1
} 
Alan Adını Güncelle
PUT https://urlkai.com/api/domain/:id/update

Ak chcete aktualizovať značkovú doménu, musíte odoslať platné údaje vo formáte JSON prostredníctvom požiadavky PUT. Údaje musia byť odoslané ako nespracované telo vašej žiadosti, ako je uvedené nižšie. V nasledujúcom príklade sú uvedené všetky parametre, ktoré môžete odoslať, ale nemusíte odoslať všetky (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
Redirectroot (voliteľné) Koreňové presmerovanie, keď niekto navštívi vašu doménu
presmerovanie404 (voliteľné) Vlastné presmerovanie 404
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Autorizácia: Nositeľ 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, pole(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "PUT",
    "url": "https://urlkai.com/api/domain/:id/update",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    body: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/domain/:id/update"
užitočné zaťaženie = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "Doména bola úspešne aktualizovaná."
} 
Odstrániť doménu
DELETE https://urlkai.com/api/domain/:id/delete

Ak chcete doménu odstrániť, musíte odoslať žiadosť o DELETE.

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

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZMAZAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'DELETE',
    "url": "https://urlkai.com/api/domain/:id/delete",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/domain/:id/delete"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "Doména bola úspešne odstránená."
} 

Pixel

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

Ak chcete získať kódy pixelov prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZÍSKAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'GET',
    "url": "https://urlkai.com/api/pixels?limit=2&page=1",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/pixels?limit=2&page=1"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "error": "0",
    "údaje": {
        "výsledok": 2,
        "perpage": 2,
        "aktuálna stránka": 1,
        "ďalšia strana": 1,
        "maxpage": 1,
        "pixely": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM Pixel",
                "tag": "GA-123456789",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "twitterpixel",
                "name": "Twitter Pixel",
                "tag": "1234567",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
} 
Vytvorenie pixelu
POST https://urlkai.com/api/pixel/add

Pomocou tohto koncového bodu je možné vytvoriť pixel. Musíte odoslať typ pixelu a značku.

Parametre Açıklama
typ (povinné) gtmpixel | Gapixel | fbpixel | AdWordsPixel | LinkedInInpixel | Twitterpixel | AdrollPixel | Quorapixel | Pinterest | Bing | Snapchat | Reddit | TikTok
meno (povinné) Vlastný názov pixelu
štítok (povinné) Značka pre pixel
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "Moje GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PRÍSPEVOK",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "gtmpixel",
	    "name": "Moje GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "POST",
    "url": "https://urlkai.com/api/pixel/add",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    body: JSON.stringify({
    "type": "gtmpixel",
    "name": "Moje GTM",
    "tag": "GTM-ABCDE"
}),
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/pixel/add"
užitočné zaťaženie = {
    "type": "gtmpixel",
    "name": "Moje GTM",
    "tag": "GTM-ABCDE"
}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{
    "type": "gtmpixel",
    "name": "Moje GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "id": 1
} 
Pixel'i Güncelle
PUT https://urlkai.com/api/pixel/:id/update

Ak chcete aktualizovať pixel, musíte odoslať platné údaje vo formáte JSON prostredníctvom požiadavky PUT. Údaje musia byť odoslané ako nespracované telo vašej žiadosti, ako je uvedené nižšie. V nasledujúcom príklade sú uvedené všetky parametre, ktoré môžete odoslať, ale nemusíte odoslať všetky (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
meno (voliteľné) Vlastný názov pixelu
štítok (povinné) Značka pre pixel
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Moje GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Moje GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "PUT",
    "url": "https://urlkai.com/api/pixel/:id/update",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Moje GTM",
    "tag": "GTM-ABCDE"
}),
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/pixel/:id/update"
užitočné zaťaženie = {
    "name": "Moje GTM",
    "tag": "GTM-ABCDE"
}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{
    "name": "Moje GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "Pixel bol úspešne aktualizovaný."
} 
Odstrániť Pixel
DELETE https://urlkai.com/api/pixel/:id/delete

Ak chcete pixel odstrániť, musíte odoslať žiadosť o odstránenie.

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

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZMAZAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'DELETE',
    "url": "https://urlkai.com/api/pixel/:id/delete",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/pixel/:id/delete"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "Pixel bol úspešne odstránený."
} 

QR Kódları

Zoznam QR kódov
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).

Parametre Açıklama
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZÍSKAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'GET',
    "url": "https://urlkai.com/api/qr?limit=2&page=1",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/qr?limit=2&page=1"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "error": "0",
    "údaje": {
        "výsledok": 2,
        "perpage": 2,
        "aktuálna stránka": 1,
        "ďalšia strana": 1,
        "maxpage": 1,
        "qrs": [
            {
                "id": 2,
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "skeny": 0,
                "name": "Google",
                "date": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/urlkai.com\/qr\/b9edfe",
                "skeny": 5,
                "name": "Google Canada",
                "date": "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 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZÍSKAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'GET',
    "url": "https://urlkai.com/api/qr/:id",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/qr/:id"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "podrobnosti": {
        "id": 1,
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "skeny": 5,
        "name": "Google Canada",
        "date": "2020-11-10 18:00:25"
    },
    "údaje": {
        "kliknutia": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Neznáme": "1"
        },
        "topReferrers": {
            "Priame, e-mail a iné": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "Facebook": 0,
            "Twitter": 0,
            "Instagram": 0
        }
    }
} 
QR kód Oluşturun
POST https://urlkai.com/api/qr/add

Ak chcete vytvoriť QR kód, musíte odoslať platné údaje vo formáte JSON prostredníctvom požiadavky POST. Údaje musia byť odoslané ako nespracované telo vašej žiadosti, ako je uvedené nižšie. V nasledujúcom príklade sú uvedené všetky parametre, ktoré môžete odoslať, ale nemusíte odoslať všetky (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
typ (povinné) text | vcard | odkaz | e-mailom | telefón | SMS | Wi-Fi
údaje (povinné) Údaje, ktoré sa majú vložiť do QR kódu. Údaje môžu byť reťazec alebo pole v závislosti od typu
pozadie (voliteľné) Farba RGB, napr. rgb(255,255,255)
popredie (voliteľné) Farba RGB, napr. rgb(0,0,0)
logo (voliteľné) Cesta k logu buď png alebo jpg
meno (voliteľné) Názov QR kódu
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "odkaz",
    "data": "https:\/\/google.com",
    "pozadie": "rgb(255,255,255)",
    "v popredí": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "Rozhranie API QR kódu"
}' 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/qr/add",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PRÍSPEVOK",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "odkaz",
	    "data": "https:\/\/google.com",
	    "pozadie": "rgb(255,255,255)",
	    "v popredí": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": "Rozhranie API QR kódu"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "POST",
    "url": "https://urlkai.com/api/qr/add",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    body: JSON.stringify({
    "type": "odkaz",
    "data": "https:\/\/google.com",
    "pozadie": "rgb(255,255,255)",
    "v popredí": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "Rozhranie API QR kódu"
}),
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/qr/add"
užitočné zaťaženie = {
    "type": "odkaz",
    "data": "https://google.com",
    "pozadie": "rgb(255,255,255)",
    "v popredí": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png",
    "name": "Rozhranie API QR kódu"
}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{
    "type": "odkaz",
    "data": "https:\/\/google.com",
    "pozadie": "rgb(255,255,255)",
    "v popredí": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "Rozhranie API QR kódu"
}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "id": 3,
    "link": "https:\/\/urlkai.com\/qr\/a58f79"
} 
Aktualizácia QR kódu
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).

Parametre Açıklama
údaje (povinné) Údaje, ktoré sa majú vložiť do QR kódu. Údaje môžu byť reťazec alebo pole v závislosti od typu
pozadie (voliteľné) Farba RGB, napr. rgb(255,255,255)
popredie (voliteľné) Farba RGB, napr. rgb(0,0,0)
logo (voliteľné) Cesta k logu buď png alebo jpg
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "odkaz",
    "data": "https:\/\/google.com",
    "pozadie": "rgb(255,255,255)",
    "v popredí": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}' 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "odkaz",
	    "data": "https:\/\/google.com",
	    "pozadie": "rgb(255,255,255)",
	    "v popredí": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "PUT",
    "url": "https://urlkai.com/api/qr/:id/update",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    body: JSON.stringify({
    "type": "odkaz",
    "data": "https:\/\/google.com",
    "pozadie": "rgb(255,255,255)",
    "v popredí": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/qr/:id/update"
užitočné zaťaženie = {
    "type": "odkaz",
    "data": "https://google.com",
    "pozadie": "rgb(255,255,255)",
    "v popredí": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{
    "type": "odkaz",
    "data": "https:\/\/google.com",
    "pozadie": "rgb(255,255,255)",
    "v popredí": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "QR bol úspešne aktualizovaný."
} 
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 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZMAZAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'DELETE',
    "url": "https://urlkai.com/api/qr/:id/delete",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/qr/:id/delete"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "QR kód bol úspešne odstránený."
} 

Kampanyalar

Zoznam kampaní
GET https://urlkai.com/api/campaigns?limit=2&page=1

Ak chcete získať kampane prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZÍSKAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'GET',
    "url": "https://urlkai.com/api/campaigns?limit=2&page=1",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "error": "0",
    "údaje": {
        "výsledok": 2,
        "perpage": 2,
        "aktuálna stránka": 1,
        "ďalšia strana": 1,
        "maxpage": 1,
        "kampane": [
            {
                "id": 1,
                "name": "Ukážková kampaň",
                "verejné": nepravdivé,
                "rotátor": nepravdivé,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Facebook kampaň",
                "verejný": pravda,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
Kampanya Oluştur
POST https://urlkai.com/api/campaign/add

Kampaň je možné pridať pomocou tohto koncového bodu.

Parametre Açıklama
meno (voliteľné) Názov kampane
slimák (voliteľné) Rotátorový slimák
verejnosť (voliteľné) Prístup
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nová kampaň",
    "slug": "nová kampaň",
    "verejný": pravdivý
}' 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PRÍSPEVOK",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Nová kampaň",
	    "slug": "nová kampaň",
	    "verejný": pravdivý
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "POST",
    "url": "https://urlkai.com/api/campaign/add",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Nová kampaň",
    "slug": "nová kampaň",
    "verejný": pravdivý
}),
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/campaign/add"
užitočné zaťaženie = {
    "name": "Nová kampaň",
    "slug": "nová kampaň",
    "verejný": pravdivý
}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{
    "name": "Nová kampaň",
    "slug": "nová kampaň",
    "verejný": pravdivý
}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "id": 3,
    "domain": "Nová kampaň",
    "verejný": pravda,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Pomocou tohto koncového bodu je možné ku kampani priradiť krátky odkaz. Koncový bod vyžaduje identifikátor kampane a identifikátor krátkeho prepojenia.

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

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PRÍSPEVOK",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "POST",
    "url": "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "Prepojenie bolo úspešne pridané do kampane."
} 
Kampanyayı Güncelle
PUT https://urlkai.com/api/campaign/:id/update

Ak chcete aktualizovať kampaň, musíte odoslať platné údaje vo formáte JSON prostredníctvom požiadavky PUT. Údaje musia byť odoslané ako nespracované telo vašej žiadosti, ako je uvedené nižšie. V nasledujúcom príklade sú uvedené všetky parametre, ktoré môžete odoslať, ale nemusíte odoslať všetky (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
meno (povinné) Názov kampane
slimák (voliteľné) Rotátorový slimák
verejnosť (voliteľné) Prístup
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "kampaň na Twitteri",
    "slug": "twitterová kampaň",
    "verejný": pravdivý
}' 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "kampaň na Twitteri",
	    "slug": "twitterová kampaň",
	    "verejný": pravdivý
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    "metóda": "PUT",
    "url": "https://urlkai.com/api/campaign/:id/update",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    body: JSON.stringify({
    "name": "kampaň na Twitteri",
    "slug": "twitterová kampaň",
    "verejný": pravdivý
}),
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/campaign/:id/update"
užitočné zaťaženie = {
    "name": "kampaň na Twitteri",
    "slug": "twitterová kampaň",
    "verejný": pravdivý
}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{
    "name": "kampaň na Twitteri",
    "slug": "twitterová kampaň",
    "verejný": pravdivý
}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "id": 3,
    "domain": "kampaň na Twitteri",
    "verejný": pravda,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
Odstrániť kampaň
DELETE https://urlkai.com/api/campaign/:id/delete

Ak chcete kampaň odstrániť, musíte odoslať žiadosť o DELETE.

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

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZMAZAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'DELETE',
    "URL": "https://urlkai.com/api/campaign/:id/delete",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/campaign/:id/delete"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "chyba": 0,
    "message": "Kampaň bola úspešne odstránená."
} 

Özel Splash

Zoznam vlastných Splash
GET https://urlkai.com/api/splash?limit=2&page=1

Ak chcete získať vlastné úvodné stránky prostredníctvom rozhrania API, môžete použiť tento koncový bod. Môžete tiež filtrovať údaje (ďalšie informácie nájdete v tabuľke).

Parametre Açıklama
medza (voliteľné) Výsledok údajov na stranu
strana (voliteľné) Žiadosť o aktuálnu stránku
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Autorizácia: Nositeľ YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, pole(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => pravda,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => pravda,
    CURLOPT_CUSTOMREQUEST => "ZÍSKAŤ",
    CURLOPT_HTTPHEADER => [
        "Oprávnenie: Nositeľ YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ozvena $response; 
var request = require('požiadavka');
var options = {
    'method': 'GET',
    "url": "https://urlkai.com/api/splash?limit=2&page=1",
    'hlavičky': {
        "Autorizácia": "Nositeľ YOURAPIKEY",
        'content-type': 'application/json'
    },
    
};
požiadavka(možnosti, funkcia (chyba, odpoveď) {
    if (chyba) vyhodiť novú chybu (chybu);
    console.log(odpoveď.telo);
}); 
Žiadosti o dovoz
url = "https://urlkai.com/api/splash?limit=2&page=1"
užitočné zaťaženie = {}
hlavičky = {
    "Autorizácia": "Nositeľ YOURAPIKEY",
    'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odpoveď.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
prosiť. Headers.Add("Autorizácia", "Nositeľ YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prosiť. Obsah = obsah;
var response = čakať na klienta. SendAsync(požiadavka);
odpoveď. EnsureSuccessStatusCode();
Console.WriteLine(čakať na odpoveď. Content.ReadAsStringAsync()); 
Sunucu durumu
{
    "error": "0",
    "údaje": {
        "výsledok": 2,
        "perpage": 2,
        "aktuálna stránka": 1,
        "ďalšia strana": 1,
        "maxpage": 1,
        "splash": [
            {
                "id": 1,
                "name": "Promo produkt 1",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Promo produkt 2",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
}