Referencia de API para desarrolladores

Empezando

Se requiere una clave API para que el sistema procese las solicitudes. Una vez que un usuario se registra, se genera automáticamente una clave API para este usuario. La clave API debe enviarse con cada solicitud (consulte el ejemplo completo a continuación). Si la clave API no se envía o está caducada, habrá un error. Asegúrese de mantener en secreto su clave API para evitar abusos.

Autenticación

Para autenticarse con el sistema API, debe enviar su clave API como un token de autorización con cada solicitud. Puede ver el código de muestra a continuación.

curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЩА",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
));

$response = curl_exec($curl); 
var request = require('request');
var options = {
    "метод": "ПОЩА",
    'url': 'https://urlkai.com/api/account',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    тяло: ''
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    console.log(response.body);
}); 
заявки за импорт
url = "https://urlkai.com/api/account"
полезен товар = {}
заглавия = {
  "Разрешение": "Приносител YOURAPIKEY",
  'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Límite de tarifa

Nuestra API tiene un limitador de velocidad para protegerse contra picos en las solicitudes para maximizar su estabilidad. Nuestro limitador de frecuencia actualmente tiene un límite de 30 solicitudes por 1 minuto. Please note that the rate might change according to the subscribed plan.

Se enviarán varios encabezados junto con la respuesta y estos se pueden examinar para determinar información diversa sobre la solicitud.

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Manejo de respuestas

Todas las respuestas de la API se devuelven en formato JSON de forma predeterminada. Para convertir esto en datos utilizables, será necesario utilizar la función adecuada según el idioma. En PHP, la función json_decode() se puede usar para convertir los datos en un objeto (predeterminado) o en una matriz (establezca el segundo parámetro en verdadero). Es muy importante verificar la clave de error ya que proporciona información sobre si hubo un error o no. También puede consultar el código de cabecera.

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

Campañas

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

За да получите кампаниите си чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).

ParámetroDescripción
граница (по избор) Резултат от данните за страница
страница (по избор) Заявка за текуща страница
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "error": "0",
    "данни": {
        "резултат": 2,
        "perpage": 2,
        "currentpage": 1,
        "следваща страница": 1,
        "maxpage": 1,
        "кампании": [
            {
                "id": 1,
                "name": "Примерна кампания",
                "public": невярно,
                "ротатор": невярно,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "домейн": "Кампания във Facebook",
                "public": вярно,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
Crear una campaña
POST https://urlkai.com/api/campaign/add

С помощта на тази крайна точка може да се добави кампания.

ParámetroDescripción
Име (по избор) Име на кампанията
плужек (по избор) Ротаторен охлюв
общественост (по избор) Достъп
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
    "name": "Нова кампания",
    "slug": "нова кампания",
    "Публичен": вярно
}' 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЩА",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Нова кампания",
	    "slug": "нова кампания",
	    "Публичен": вярно
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "ПОЩА",
    'url': 'https://urlkai.com/api/campaign/add',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Нова кампания",
    "slug": "нова кампания",
    "Публичен": вярно
}),
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    console.log(response.body);
}); 
заявки за импорт
url = "https://urlkai.com/api/campaign/add"
полезен товар = {
    "name": "Нова кампания",
    "slug": "нова кампания",
    "Публичен": вярно
}
заглавия = {
    "Разрешение": "Приносител YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
    "name": "Нова кампания",
    "slug": "нова кампания",
    "Публичен": вярно
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "id": 3,
    "domain": "Нова кампания",
    "public": вярно,
    "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' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЩА",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "ПОЩА",
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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 = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "message": "Връзката е успешно добавена към кампанията."
} 
Actualizar campaña
PUT https://urlkai.com/api/campaign/:id/update

За да актуализирате кампания, трябва да изпратите валидни данни в JSON чрез PUT заявка. Данните трябва да бъдат изпратени като необработен текст на вашата заявка, както е показано по-долу. Примерът по-долу показва всички параметри, които можете да изпратите, но не сте длъжни да изпращате всички (вижте таблицата за повече информация).

ParámetroDescripción
Име (задължително) Име на кампанията
плужек (по избор) Ротаторен охлюв
общественост (по избор) Достъп
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
    "name": "Кампания в Twitter",
    "slug": "кампания в Twitter",
    "Публичен": вярно
}' 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Кампания в Twitter",
	    "slug": "кампания в Twitter",
	    "Публичен": вярно
	}',
));

$response = curl_exec($curl);

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

За да изтриете кампания, трябва да изпратите заявка за изтриване.

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ИЗТРИВАНЕ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "ИЗТРИВАНЕ",
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "message": "Кампанията е изтрита успешно."
} 

Canales

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

За да получите каналите си чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).

ParámetroDescripción
граница (по избор) Резултат от данните за страница
страница (по избор) Заявка за текуща страница
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "error": "0",
    "данни": {
        "резултат": 2,
        "perpage": 2,
        "currentpage": 1,
        "следваща страница": 1,
        "maxpage": 1,
        "канали": [
            {
                "id": 1,
                "name": "Канал 1",
                "description": "Описание на канал 1",
                "color": "#000000",
                "Със звезда": Вярно
            },
            {
                "id": 2,
                "name": "Канал 2",
                "description": "Описание на канал 2",
                "color": "#FF0000",
                "със звезда": фалшиво
            }
        ]
    }
} 
Списък на елементите на канала
GET https://urlkai.com/api/channel/:id?limit=1&page=1

За да получите елементи в избрани канали чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).

ParámetroDescripción
граница (по избор) Резултат от данните за страница
страница (по избор) Заявка за текуща страница
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "error": "0",
    "данни": {
        "резултат": 2,
        "perpage": 2,
        "currentpage": 1,
        "следваща страница": 1,
        "maxpage": 1,
        "предмети": [
            {
                "type": "връзки",
                "id": 1,
                "title": "Моята примерна връзка",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "дата": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "Моята примерна биография",
                "preview": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "дата": "2022-06-01"
            }
        ]
    }
} 
Crear un canal
POST https://urlkai.com/api/channel/add

С помощта на тази крайна точка може да се добави канал.

ParámetroDescripción
Име (задължително) Име на канала
описание (по избор) Описание на канала
цвят (по избор) Цвят на значката на канала (HEX)
Участва (по избор) Звезда на канала или не (вярно или невярно)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
    "name": "Нов канал",
    "description": "Моят нов канал",
    "color": "#000000",
    "Със звезда": Вярно
}' 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЩА",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Нов канал",
	    "description": "Моят нов канал",
	    "color": "#000000",
	    "Със звезда": Вярно
	}',
));

$response = curl_exec($curl);

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

Артикул може да бъде присвоен към всеки канал чрез изпращане на заявка с идентификатора на канала, вида на артикула (връзки, биография или qr) и идентификатора на артикула.

ParámetroDescripción
:channelid (задължително) Идентификатор на канала
:вид (задължително) връзки или биография или QR
:itemid (задължително) ID на артикула
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЩА",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "ПОЩА",
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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 = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "message": "Елементът е успешно добавен към канала."
} 
Actualizar canal
PUT https://urlkai.com/api/channel/:id/update

За да актуализирате канал, трябва да изпратите валидни данни в JSON чрез PUT заявка. Данните трябва да бъдат изпратени като необработен текст на вашата заявка, както е показано по-долу. Примерът по-долу показва всички параметри, които можете да изпратите, но не сте длъжни да изпращате всички (вижте таблицата за повече информация).

ParámetroDescripción
Име (по избор) Име на канала
описание (по избор) Описание на канала
цвят (по избор) Цвят на значката на канала (HEX)
Участва (по избор) Звезда на канала или не (вярно или невярно)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: 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 => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "име": "Acme Corp",
	    "description": "канал за артикули за Acme Corp",
	    "color": "#FFFFFF",
	    "със звезда": фалшиво
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "PUT",
    'url': 'https://urlkai.com/api/channel/:id/update',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "име": "Acme Corp",
    "description": "канал за артикули за Acme Corp",
    "color": "#FFFFFF",
    "със звезда": фалшиво
}),
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
    "име": "Acme Corp",
    "description": "канал за артикули за Acme Corp",
    "color": "#FFFFFF",
    "със звезда": фалшиво
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "message": "Каналът е актуализиран успешно."
} 
Изтриване на канал
DELETE https://urlkai.com/api/channel/:id/delete

За да изтриете канал, трябва да изпратите заявка за изтриване. Всички елементи също ще бъдат отменени.

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ИЗТРИВАНЕ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "ИЗТРИВАНЕ",
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "message": "Каналът е изтрит успешно."
} 

Cuenta

Obtener cuenta
GET https://urlkai.com/api/account

Para obtener información sobre la cuenta, puede enviar una solicitud a este punto final y devolverá datos sobre la cuenta.

curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    console.log(response.body);
}); 
заявки за импорт
url = "https://urlkai.com/api/account"
полезен товар = {}
заглавия = {
    "Разрешение": "Приносител YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "данни": {
        "id": 1,
        "имейл": " [имейл защитен] ",
        "username": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "изтича": "2022-11-15 15:00:00",
        "Регистриран": "2020-11-10 18:01:43"
    }
} 
Actualizar cuenta
PUT https://urlkai.com/api/account/update

Para actualizar la información de la cuenta, puede enviar una solicitud a este punto final y actualizará los datos de la cuenta.

curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
    "имейл": " [имейл защитен] ",
    "password": "newpassword"
}' 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "имейл": " [имейл защитен] ",
	    "password": "newpassword"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "PUT",
    'url': 'https://urlkai.com/api/account/update',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "имейл": " [имейл защитен] ",
    "password": "newpassword"
}),
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
    "имейл": " [имейл защитен] ",
    "password": "newpassword"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "message": "Акаунтът е актуализиран успешно."
} 

Códigos QR

Избройте QR кодове
GET https://urlkai.com/api/qr?limit=2&page=1

Para obtener sus códigos QR a través de la API, puede usar este punto final. También puede filtrar datos (Ver tabla para más información).

ParámetroDescripción
граница (по избор) Резултат от данните за страница
страница (по избор) Заявка за текуща страница
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "error": "0",
    "данни": {
        "резултат": 2,
        "perpage": 2,
        "currentpage": 1,
        "следваща страница": 1,
        "maxpage": 1,
        "QRS": [
            {
                "id": 2,
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "сканирания": 0,
                "name": "Google",
                "Дата": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/urlkai.com\/qr\/b9edfe",
                "сканирания": 5,
                "name": "Google Canada",
                "дата": "2020-11-10 18:00:25"
            }
        ]
    }
} 
Obtenga un solo código QR
GET https://urlkai.com/api/qr/:id

Para obtener detalles de un solo código QR a través de la API, puede usar este punto final.

curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    console.log(response.body);
}); 
заявки за импорт
url = "https://urlkai.com/api/qr/:id"
полезен товар = {}
заглавия = {
    "Разрешение": "Приносител YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "подробности": {
        "id": 1,
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "сканирания": 5,
        "name": "Google Canada",
        "дата": "2020-11-10 18:00:25"
    },
    "данни": {
        "кликвания": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Неизвестен": "1"
        },
        "topReferrers": {
            "Директни, имейл и други": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "Фейсбук": 0,
            "Туитър": 0,
            "Инстаграм": 0
        }
    }
} 
Crear un código QR
POST https://urlkai.com/api/qr/add

За да създадете QR код, трябва да изпратите валидни данни в JSON чрез POST заявка. Данните трябва да бъдат изпратени като необработен текст на вашата заявка, както е показано по-долу. Примерът по-долу показва всички параметри, които можете да изпратите, но не сте длъжни да изпращате всички (вижте таблицата за повече информация).

ParámetroDescripción
вид (задължително) текст | VCARD | връзка | Електронна поща | телефон | SMS | WiFi
данни (задължително) Данните, които трябва да бъдат вградени в QR кода. Данните могат да бъдат низови или масивни в зависимост от типа
фон (по избор) RGB цвят, например rgb(255,255,255)
преден план (по избор) RGB цвят, например rgb(0,0,0)
лого (по избор) Път към логото png или jpg
Име (по избор) Име на QR код
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: 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 => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЩА",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 = {
    "метод": "ПОЩА",
    'url': 'https://urlkai.com/api/qr/add',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: 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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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)",
    "logo": "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 = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
    "type": "връзка",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "преден план": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API за QR код"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "id": 3,
    "link": "https:\/\/urlkai.com\/qr\/a58f79"
} 
Актуализиране на QR кода
PUT https://urlkai.com/api/qr/:id/update

Para actualizar un código QR, debe enviar datos válidos en JSON a través de una solicitud PUT. Los datos deben enviarse como el cuerpo sin procesar de su solicitud, como se muestra a continuación. El siguiente ejemplo muestra todos los parámetros que puede enviar, pero no es necesario que los envíe todos (consulte la tabla para obtener más información).

ParámetroDescripció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' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: 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 => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 = {
    "метод": "PUT",
    'url': 'https://urlkai.com/api/qr/:id/update',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: 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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
    "type": "връзка",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "преден план": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "message": "QR е актуализиран успешно."
} 
Eliminar un código QR
DELETE https://urlkai.com/api/qr/:id/delete

Para eliminar un código QR, debe enviar una solicitud de ELIMINACIÓN.

curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ИЗТРИВАНЕ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "ИЗТРИВАНЕ",
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "message": "QR кодът е изтрит успешно."
} 

Dominios de marca

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

За да получите вашите маркови домейни чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).

ParámetroDescripción
граница (по избор) Резултат от данните за страница
страница (по избор) Заявка за текуща страница
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "error": "0",
    "данни": {
        "резултат": 2,
        "perpage": 2,
        "currentpage": 1,
        "следваща страница": 1,
        "maxpage": 1,
        "домейни": [
            {
                "id": 1,
                "domain": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "id": 2,
                "domain": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
} 
Създайте брандиран домейн
POST https://urlkai.com/api/domain/add

С помощта на тази крайна точка може да се добави домейн. Моля, уверете се, че домейнът е правилно насочен към нашия сървър.

ParámetroDescripción
домейн (задължително) Брандиран домейн, включително http или https
Пренасочване (по избор) Пренасочване на root, когато някой посети домейна ви
пренасочване404 (по избор) Персонализирано 404 пренасочване
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: 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 => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЩА",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "domain": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "ПОЩА",
    'url': 'https://urlkai.com/api/domain/add',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    console.log(response.body);
}); 
заявки за импорт
url = "https://urlkai.com/api/domain/add"
полезен товар = {
    "domain": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
заглавия = {
    "Разрешение": "Приносител YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "id": 1
} 
Actualizar dominio
PUT https://urlkai.com/api/domain/:id/update

За да актуализирате брандиран домейн, трябва да изпратите валидни данни в JSON чрез PUT заявка. Данните трябва да бъдат изпратени като необработен текст на вашата заявка, както е показано по-долу. Примерът по-долу показва всички параметри, които можете да изпратите, но не сте длъжни да изпращате всички (вижте таблицата за повече информация).

ParámetroDescripción
Пренасочване (по избор) Пренасочване на root, когато някой посети домейна ви
пренасочване404 (по избор) Персонализирано 404 пренасочване
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

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

За да изтриете домейн, трябва да изпратите заявка за изтриване.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ИЗТРИВАНЕ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "ИЗТРИВАНЕ",
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "message": "Домейнът е изтрит успешно."
} 

Enlaces


Файлове

Списъчни файлове
GET https://urlkai.com/api/files?limit=2&page=1

Вземете всичките си файлове. Можете също да търсите по име.

ParámetroDescripción
Име (по избор) Търсене на файл по име
граница (по избор) Резултат от данните за страница
страница (по избор) Заявка за текуща страница
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/files?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/files?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
import requests
url = "https://urlkai.com/api/files?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/files?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Respuesta del servidor
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/fFkGE",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/gqIpW",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/LQLXS",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
Качване на файл
POST https://urlkai.com/api/files/upload/:filename?name=My+File

Качете файл, като изпратите двоичните данни като тялото на публикацията. Трябва да изпратите името на файла, включително разширението, вместо :filename в URL адреса (напр. brandkit.zip). Можете да зададете опции, като изпратите следните параметри.

ParámetroDescripción
Име (по избор) Име на файла
обичай (по избор) Персонализиран псевдоним вместо произволен псевдоним.
домейн (по избор) Персонализиран домейн
парола (по избор) Защита с парола
Изтичане (по избор) Изтичане на примера за изтегляне 2021-09-28
Максимални изтегляния (по избор) Максимален брой изтегляния
curl --location --request POST 'https://urlkai.com/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/files/upload/:filename?name=My+File",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOURAPIKEY",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '"BINARY DATA"',
));

$response = curl_exec($curl);

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

Personalizar página de bienvenida

Списък с персонализирани пръски
GET https://urlkai.com/api/splash?limit=2&page=1

За да получите персонализирани начални страници чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).

ParámetroDescripción
граница (по избор) Резултат от данните за страница
страница (по избор) Заявка за текуща страница
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "error": "0",
    "данни": {
        "резултат": 2,
        "perpage": 2,
        "currentpage": 1,
        "следваща страница": 1,
        "maxpage": 1,
        "Splash": [
            {
                "id": 1,
                "name": "Продукт 1 Промоция",
                "дата": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Продукт 2 Промоция",
                "дата": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Пиксела

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

За да получите вашите пикселни кодове чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).

ParámetroDescripción
граница (по избор) Резултат от данните за страница
страница (по избор) Заявка за текуща страница
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "error": "0",
    "данни": {
        "резултат": 2,
        "perpage": 2,
        "currentpage": 1,
        "следваща страница": 1,
        "maxpage": 1,
        "пиксели": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM Pixel",
                "tag": "GA-123456789",
                "дата": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "twitterpixel",
                "име": "Twitter Pixel",
                "tag": "1234567",
                "дата": "2020-11-10 18:10:00"
            }
        ]
    }
} 
Създаване на пиксел
POST https://urlkai.com/api/pixel/add

С помощта на тази крайна точка може да се създаде пиксел. Трябва да изпратите типа пиксел и етикета.

ParámetroDescripción
вид (задължително) gtmpixel | гапиксел | fbpixel | AdWordsPixel | LinkedIn | Туитърпиксел | AdrollPixel | Quorapixel | pinterest | Bing | Snapchat | Reddit | ТикТок
Име (задължително) Персонализирано име за пиксела ви
етикет (задължително) Маркерът за пиксела
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "име": "Моят GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЩА",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "gtmpixel",
	    "име": "Моят GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "ПОЩА",
    'url': 'https://urlkai.com/api/pixel/add',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "type": "gtmpixel",
    "име": "Моят GTM",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    console.log(response.body);
}); 
заявки за импорт
url = "https://urlkai.com/api/pixel/add"
полезен товар = {
    "type": "gtmpixel",
    "име": "Моят GTM",
    "tag": "GTM-ABCDE"
}
заглавия = {
    "Разрешение": "Приносител YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
    "type": "gtmpixel",
    "име": "Моят GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "id": 1
} 
Actualizar píxel
PUT https://urlkai.com/api/pixel/:id/update

За да актуализирате пиксел, трябва да изпратите валидни данни в JSON чрез PUT заявка. Данните трябва да бъдат изпратени като необработен текст на вашата заявка, както е показано по-долу. Примерът по-долу показва всички параметри, които можете да изпратите, но не сте длъжни да изпращате всички (вижте таблицата за повече информация).

ParámetroDescripción
Име (по избор) Персонализирано име за пиксела ви
етикет (задължително) Маркерът за пиксела
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
    "име": "Моят GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "име": "Моят GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "PUT",
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "име": "Моят GTM",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    console.log(response.body);
}); 
заявки за импорт
url = "https://urlkai.com/api/pixel/:id/update"
полезен товар = {
    "име": "Моят GTM",
    "tag": "GTM-ABCDE"
}
заглавия = {
    "Разрешение": "Приносител YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
    "име": "Моят GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "message": "Pixel е актуализиран успешно."
} 
Изтриване на пиксел
DELETE https://urlkai.com/api/pixel/:id/delete

За да изтриете пиксел, трябва да изпратите заявка за изтриване.

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ИЗТРИВАНЕ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ехо $response; 
var request = require('request');
var options = {
    "метод": "ИЗТРИВАНЕ",
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'headers': {
        "Разрешение": "Приносител YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "грешка": 0,
    "message": "Pixel е изтрит успешно."
} 

Superposiciones de CTA

Списък CTA наслагвания
GET https://urlkai.com/api/overlay?limit=2&page=1

За да получите cta наслагвания чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).

ParámetroDescripción
граница (по избор) Резултат от данните за страница
страница (по избор) Заявка за текуща страница
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, масив(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => вярно,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => вярно,
    CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
    CURLOPT_HTTPHEADER => [
        "Упълномощаване: Приносител YOURAPIKEY",
        "Тип съдържание: приложение/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 (error, response) {
    ако (грешка) хвърли нов Грешка(грешка);
    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=полезен товар)
print(response.text) 
var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "error": "0",
    "данни": {
        "резултат": 2,
        "perpage": 2,
        "currentpage": 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"
            }
        ]
    }
}