Geliştiriciler için API Referansı

Башларкен

İ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.

Кимлик Догрулама

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' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЧТА",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
));

$response = curl_exec($curl); 
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/account',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    Тело: ''
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/account"
полезная нагрузка = {}
заголовки = {
  'Авторизация': 'Предъявитель YOURAPIKEY',
  'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. 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. Обратите внимание, что тариф может меняться в зависимости от подписанного плана.

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ı

Список оверлеев CTA
GET https://urlkai.com/api/overlay?limit=2&page=1

Чтобы получить оверлеи cta через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/overlay?limit=2&page=1"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": "0",
    "data": {
        "результат": 2,
        "perpage": 2,
        "текущая страница": 1,
        "Следующая страница": 1,
        "maxpage": 1,
        "CTA": [
            {
                "id": 1,
                "type": "сообщение",
                "name": "Товар 1 Промо",
                "Дата": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "контакт",
                "name": "Контактная страница",
                "Дата": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Хесап

Хесап Аль
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' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/account',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/account"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "data": {
        "id": 1,
        "Электронная почта": " [электронная почта защищена] ",
        "username": "sampleuser",
        "аватар": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "истекает": "2022-11-15 15:00:00",
        "Зарегистрировано": "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' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "Электронная почта": " [электронная почта защищена] ",
    "password": "newpassword"
}' 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПУТ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "Электронная почта": " [электронная почта защищена] ",
	    "password": "newpassword"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/account/update',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "Электронная почта": " [электронная почта защищена] ",
    "password": "newpassword"
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/account/update"
полезная нагрузка = {
    "Электронная почта": " [электронная почта защищена] ",
    "password": "newpassword"
}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "Электронная почта": " [электронная почта защищена] ",
    "password": "newpassword"
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "Аккаунт успешно обновлен."
} 

Каналар

Список каналов
GET https://urlkai.com/api/channels?limit=2&page=1

Чтобы получить свои каналы через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/channels?limit=2&page=1"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": "0",
    "data": {
        "результат": 2,
        "perpage": 2,
        "текущая страница": 1,
        "Следующая страница": 1,
        "maxpage": 1,
        "каналы": [
            {
                "id": 1,
                "name": "Канал 1",
                "description": "Описание канала 1",
                "цвет": "#000000",
                "В звездах": правда
            },
            {
                "id": 2,
                "name": "Канал 2",
                "description": "Описание канала 2",
                "color": "#FF0000",
                "В звездах": Ложь
            }
        ]
    }
} 
Список элементов канала
GET https://urlkai.com/api/channel/:id?limit=1&page=1

Чтобы получить элементы в выбранных каналах через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/channel/:id?limit=1&page=1"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": "0",
    "data": {
        "результат": 2,
        "perpage": 2,
        "текущая страница": 1,
        "Следующая страница": 1,
        "maxpage": 1,
        "предметы": [
            {
                "type": "ссылки",
                "id": 1,
                "title": "Мой образец ссылки",
                "превью": "https:\/\/google.com",
                "ссылка": "https:\/\/urlkai.com\/google",
                "Дата": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "Мой образец биографии",
                "превью": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "Дата": "2022-06-01"
            }
        ]
    }
} 
Канал Олуштур
POST https://urlkai.com/api/channel/add

С помощью этой конечной точки можно добавить канал.

Параметрометр Ачиклама
имя (обязательно) Название канала
описание (необязательно) Описание канала
Цвет (необязательно) Цвет значка канала (HEX)
усеянный (необязательно) Помечать канал звездочкой или нет (верно или ложно)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "name": "Новый канал",
    "description": "мой новый канал",
    "цвет": "#000000",
    "В звездах": правда
}' 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЧТА",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Новый канал",
	    "description": "мой новый канал",
	    "цвет": "#000000",
	    "В звездах": правда
	}',
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/add',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "name": "Новый канал",
    "description": "мой новый канал",
    "цвет": "#000000",
    "В звездах": правда
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/channel/add"
полезная нагрузка = {
    "name": "Новый канал",
    "description": "мой новый канал",
    "цвет": "#000000",
    "В звездах": правда
}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "Новый канал",
    "description": "мой новый канал",
    "цвет": "#000000",
    "В звездах": правда
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "id": 3,
    "name": "Новый канал",
    "description": "мой новый канал",
    "цвет": "#000000",
    "В звездах": правда
} 
Назначение элемента каналу
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Элемент может быть назначен любому каналу, отправив запрос с идентификатором канала, типом элемента (ссылки, биография или qr) и идентификатором элемента.

Параметрометр Ачиклама
:channelid (обязательно) Идентификатор канала
:тип (обязательные) ссылки или биография или QR
:itemid (обязательно) ID элемента
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЧТА",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "Товар успешно добавлен в канал."
} 
Kanalı Güncelle
PUT https://urlkai.com/api/channel/:id/update

Чтобы обновить канал, нужно отправить валидные данные в формате JSON через PUT-запрос. Данные должны быть отправлены в виде исходного текста вашего запроса, как показано ниже. В приведенном ниже примере показаны все параметры, которые вы можете отправить, но не обязаны отправлять все (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
имя (необязательно) Название канала
описание (необязательно) Описание канала
Цвет (необязательно) Цвет значка канала (HEX)
усеянный (необязательно) Помечать канал звездочкой или нет (верно или ложно)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "название": "Acme Corp,"
    "description": "канал для товаров для Acme Corp,"
    "color": "#FFFFFF",
    "В звездах": Ложь
}' 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПУТ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "название": "Acme Corp,"
	    "description": "канал для товаров для Acme Corp,"
	    "color": "#FFFFFF",
	    "В звездах": Ложь
	}',
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/channel/:id/update',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "название": "Acme Corp,"
    "description": "канал для товаров для Acme Corp,"
    "color": "#FFFFFF",
    "В звездах": Ложь
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/channel/:id/update"
полезная нагрузка = {
    "название": "Acme Corp,"
    "description": "канал для товаров для Acme Corp,"
    "color": "#FFFFFF",
    "В звездах": Ложь
}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "название": "Acme Corp,"
    "description": "канал для товаров для Acme Corp,"
    "color": "#FFFFFF",
    "В звездах": Ложь
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "Канал успешно обновлен."
} 
Удалить канал
DELETE https://urlkai.com/api/channel/:id/delete

Чтобы удалить канал, нужно отправить запрос DELETE. Все предметы также будут неназначены.

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "УДАЛИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/channel/:id/delete"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "Канал успешно удален."
} 

Markalı Alan Adları

Список брендированных доменов
GET https://urlkai.com/api/domains?limit=2&page=1

Чтобы получить свои брендированные домены через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/domains?limit=2&page=1"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": "0",
    "data": {
        "результат": 2,
        "perpage": 2,
        "текущая страница": 1,
        "Следующая страница": 1,
        "maxpage": 1,
        "домены": [
            {
                "id": 1,
                "domain": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "id": 2,
                "domain": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
} 
Создание брендированного домена
POST https://urlkai.com/api/domain/add

Домен может быть добавлен с помощью этой конечной точки. Пожалуйста, убедитесь, что домен правильно указан на наш сервер.

Параметрометр Ачиклама
домен (обязательно) Брендированный домен, включающий http или https
redirectroot (необязательно) Корневая переадресация при посещении вашего домена
редирект404 (необязательно) Пользовательский редирект 404
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок '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, массив(
    CURLOPT_URL => "https://urlkai.com/api/domain/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЧТА",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель 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);
эхо $response; 
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/domain/add',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/domain/add"
полезная нагрузка = {
    "домен": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "ID": 1
} 
Alan Adını Güncelle
PUT https://urlkai.com/api/domain/:id/update

Чтобы обновить брендированный домен, нужно отправить валидные данные в формате JSON через PUT-запрос. Данные должны быть отправлены в виде исходного текста вашего запроса, как показано ниже. В приведенном ниже примере показаны все параметры, которые вы можете отправить, но не обязаны отправлять все (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
redirectroot (необязательно) Корневая переадресация при посещении вашего домена
редирект404 (необязательно) Пользовательский редирект 404
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПУТ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель 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);
эхо $response; 
var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/domain/:id/update',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/domain/:id/update"
полезная нагрузка = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "Домен успешно обновлен."
} 
Удалить домен
DELETE https://urlkai.com/api/domain/:id/delete

Чтобы удалить домен, необходимо отправить запрос DELETE.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "УДАЛИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/domain/:id/delete"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "Домен успешно удален."
} 

Пиксель

Список пикселей
GET https://urlkai.com/api/pixels?limit=2&page=1

Чтобы получить коды пикселей через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/pixels?limit=2&page=1"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": "0",
    "data": {
        "результат": 2,
        "perpage": 2,
        "текущая страница": 1,
        "Следующая страница": 1,
        "maxpage": 1,
        "пиксели": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM Pixel,"
                "тег": "GA-123456789",
                "Дата": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "twitterpixel",
                "name": "Twitter Pixel,"
                "tag": "1234567",
                "Дата": "2020-11-10 18:10:00"
            }
        ]
    }
} 
Создание пикселя
POST https://urlkai.com/api/pixel/add

С помощью этой конечной точки можно создать пиксель. Вам нужно отправить тип пикселя и тег.

Параметрометр Ачиклама
тип (обязательно) gtmpixel | Гапиксель | FBPIXEL | adwordspixel | linkedinpixel | Твиттерпиксель | adrollpixel | Кворапиксель | Пинтерест | Бинг | Снэпчат | Реддит | Тикток
имя (обязательно) Пользовательское имя для пикселя
ярлык (обязательно) Тег для пикселя
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "Мой GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЧТА",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "gtmpixel",
	    "name": "Мой GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/pixel/add',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "type": "gtmpixel",
    "name": "Мой GTM",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/pixel/add"
полезная нагрузка = {
    "type": "gtmpixel",
    "name": "Мой GTM",
    "tag": "GTM-ABCDE"
}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "type": "gtmpixel",
    "name": "Мой GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "ID": 1
} 
Pixel'i Güncelle
PUT https://urlkai.com/api/pixel/:id/update

Чтобы обновить пиксель, нужно отправить валидные данные в формате JSON через PUT-запрос. Данные должны быть отправлены в виде исходного текста вашего запроса, как показано ниже. В приведенном ниже примере показаны все параметры, которые вы можете отправить, но не обязаны отправлять все (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
имя (необязательно) Пользовательское имя для пикселя
ярлык (обязательно) Тег для пикселя
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "name": "Мой GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПУТ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Мой GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "name": "Мой GTM",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/pixel/:id/update"
полезная нагрузка = {
    "name": "Мой GTM",
    "tag": "GTM-ABCDE"
}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "Мой GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "Пиксель успешно обновился."
} 
Удалить пиксель
DELETE https://urlkai.com/api/pixel/:id/delete

Чтобы удалить пиксель, нужно отправить запрос DELETE.

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "УДАЛИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/pixel/:id/delete"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "Пиксель был успешно удален."
} 

QR Kodları

Список 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).

Параметрометр Ачиклама
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/qr?limit=2&page=1"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": "0",
    "data": {
        "результат": 2,
        "perpage": 2,
        "текущая страница": 1,
        "Следующая страница": 1,
        "maxpage": 1,
        "QRS": [
            {
                "id": 2,
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "сканы": 0,
                "name": "Google",
                "Дата": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/urlkai.com\/qr\/b9edfe",
                "сканы": 5,
                "name": "Google Canada,"
                "Дата": "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' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/qr/:id',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/qr/:id"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "подробности": {
        "id": 1,
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "сканы": 5,
        "name": "Google Canada,"
        "Дата": "2020-11-10 18:00:25"
    },
    "data": {
        "клики": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Неизвестный": "1"
        },
        "topReferrers": {
            "Директ, электронная почта и другое": "1"
        },
        "topBrowsers": {
            "Хром": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "фейсбук": 0,
            "Твиттер": 0,
            "Инстаграм": 0
        }
    }
} 
QR Kodu Oluşturun
POST https://urlkai.com/api/qr/add

Чтобы создать QR-код, вам нужно отправить действительные данные в формате JSON через POST-запрос. Данные должны быть отправлены в виде исходного текста вашего запроса, как показано ниже. В приведенном ниже примере показаны все параметры, которые вы можете отправить, но не обязаны отправлять все (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
тип (обязательный) текст | VCARD | ссылка | Электронная почта | Телефон | смс | Wi-Fi
данные (обязательно) Данные должны быть встроены в QR-код. Данные могут быть строковыми или массивными в зависимости от типа
фон (необязательно) Цвет RGB, например, rgb (255,255,255)
передний план (необязательно) Цвет RGB, например, rgb(0,0,0)
лого (необязательно) Путь к логотипу либо png, либо jpg
имя (необязательно) Название QR-кода
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "type": "ссылка",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255),"
    "передний план": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API QR-кода"
}' 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/qr/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЧТА",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "ссылка",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255),"
	    "передний план": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": "API QR-кода"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/qr/add',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "type": "ссылка",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255),"
    "передний план": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API QR-кода"
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/qr/add"
полезная нагрузка = {
    "type": "ссылка",
    "data": "https://google.com",
    "background": "rgb(255,255,255),"
    "передний план": "rgb(0,0,0)",
    "логотип": "https://site.com/logo.png",
    "name": "API QR-кода"
}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "type": "ссылка",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255),"
    "передний план": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API QR-кода"
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "id": 3,
    "link": "https:\/\/urlkai.com\/qr\/a58f79"
} 
Обновить 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).

Параметрометр Ачиклама
данные (обязательно) Данные должны быть встроены в QR-код. Данные могут быть строковыми или массивными в зависимости от типа
фон (необязательно) Цвет RGB, например, rgb (255,255,255)
передний план (необязательно) Цвет RGB, например, rgb(0,0,0)
лого (необязательно) Путь к логотипу либо png, либо jpg
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "type": "ссылка",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255),"
    "передний план": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}' 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПУТ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "ссылка",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255),"
	    "передний план": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/qr/:id/update',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "type": "ссылка",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255),"
    "передний план": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/qr/:id/update"
полезная нагрузка = {
    "type": "ссылка",
    "data": "https://google.com",
    "background": "rgb(255,255,255),"
    "передний план": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "type": "ссылка",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255),"
    "передний план": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "QR успешно обновлен."
} 
QR Кодуну Сил
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' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "УДАЛИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/qr/:id/delete"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "QR-код был успешно удален."
} 

Кампаньялар

Список кампаний
GET https://urlkai.com/api/campaigns?limit=2&page=1

Чтобы получать свои рассылки через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/campaigns?limit=2&page=1"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": "0",
    "data": {
        "результат": 2,
        "perpage": 2,
        "текущая страница": 1,
        "Следующая страница": 1,
        "maxpage": 1,
        "кампании": [
            {
                "id": 1,
                "name": "Пример кампании",
                "public": false,
                "rotator": false,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Кампания в Facebook,"
                "публичный": верно,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
Кампанья Олуштур
POST https://urlkai.com/api/campaign/add

С помощью этой конечной точки можно добавить кампанию.

Параметрометр Ачиклама
имя (необязательно) Название кампании
слизняк (необязательно) Вращательный слаг
общественный (необязательно) Доступ
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "name": "Новая кампания",
    "slug": "new-campaign",
    "Публичный": правда
}' 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЧТА",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Новая кампания",
	    "slug": "new-campaign",
	    "Публичный": правда
	}',
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/add',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "name": "Новая кампания",
    "slug": "new-campaign",
    "Публичный": правда
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/campaign/add"
полезная нагрузка = {
    "name": "Новая кампания",
    "slug": "new-campaign",
    "Публичный": правда
}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "Новая кампания",
    "slug": "new-campaign",
    "Публичный": правда
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "id": 3,
    "domain": "Новая кампания",
    "публичный": верно,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

С помощью этой конечной точки кампании можно назначить короткую ссылку. Для конечной точки требуется идентификатор кампании и идентификатор короткой ссылки.

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЧТА",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "Ссылка успешно добавлена в рассылку."
} 
Kampanyayı Güncelle
PUT https://urlkai.com/api/campaign/:id/update

Чтобы обновить кампанию, нужно отправить валидные данные в формате JSON через PUT-запрос. Данные должны быть отправлены в виде исходного текста вашего запроса, как показано ниже. В приведенном ниже примере показаны все параметры, которые вы можете отправить, но не обязаны отправлять все (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
имя (обязательно) Название кампании
слизняк (необязательно) Вращательный слаг
общественный (необязательно) Доступ
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "name": "Кампания в Twitter",
    "слизняк": "твиттер-кампания",
    "Публичный": правда
}' 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПУТ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Кампания в Twitter",
	    "слизняк": "твиттер-кампания",
	    "Публичный": правда
	}',
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "name": "Кампания в Twitter",
    "слизняк": "твиттер-кампания",
    "Публичный": правда
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/campaign/:id/update"
полезная нагрузка = {
    "name": "Кампания в Twitter",
    "слизняк": "твиттер-кампания",
    "Публичный": правда
}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "Кампания в Twitter",
    "слизняк": "твиттер-кампания",
    "Публичный": правда
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "id": 3,
    "domain": "Кампания в Twitter",
    "публичный": верно,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
Удалить кампанию
DELETE https://urlkai.com/api/campaign/:id/delete

Чтобы удалить рассылку, нужно отправить запрос DELETE.

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "УДАЛИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'DELETE',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/campaign/:id/delete"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": 0,
    "message": "Кампания успешно удалена."
} 

Озель Сплэш

Список пользовательских заставок
GET https://urlkai.com/api/splash?limit=2&page=1

Чтобы получить кастомные заставки через API, вы можете использовать эту конечную точку. Вы также можете фильтровать данные (см. таблицу для получения дополнительной информации).

Параметрометр Ачиклама
предел (необязательно) Постраничный результат данных
страница (необязательно) Запрос текущей страницы
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИТЬ",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response; 
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
Запросы на импорт
URL = "https://urlkai.com/api/splash?limit=2&page=1"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync()); 
Сунуку дуруму
{
    "ошибка": "0",
    "data": {
        "результат": 2,
        "perpage": 2,
        "текущая страница": 1,
        "Следующая страница": 1,
        "maxpage": 1,
        "Всплеск": [
            {
                "id": 1,
                "name": "Товар 1 Промо",
                "Дата": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Товар 2 Промо",
                "Дата": "2020-11-10 18:10:00"
            }
        ]
    }
}