# Developers
**Source:** https://ru.urlkai.com/developers
**Language:** Russian

---

Начало работы 

Аутентификация 

Ограничение скорости 

Обработка ответов 

###### Счет

Получить аккаунт 

Обновить учетную запись

###### Брендированные домены

Список брендированных доменов 

Создание брендированного домена 

Обновить домен 

Удалить домен

###### Оверлеи CTA

Список оверлеев CTA

###### Кампании

Список кампаний 

Создать кампанию 

Назначение ссылки на кампанию 

Кампания по обновлению 

Удалить кампанию

###### Каналами

Список каналов 

Список элементов канала 

Создание канала 

Назначение элемента каналу 

Канал обновлений 

Удалить канал

###### Пользовательский всплеск

Список пользовательских заставок

###### Файлы

Список файлов 

Загрузить файл

###### Дюны

Список ссылок 

Получите одну ссылку 

Сокращение ссылки 

Ссылка на обновление 

Удаление ссылки

###### Пикселей

Список пикселей 

Создание пикселя 

Обновление пикселя 

Удалить пиксель

###### QR-коды

Список QR-кодов 

Получите один QR-код 

Создание QR-кода 

Обновить QR-код 

Удаление QR-кода

#### Справочник по API для разработчиков

###### Начало работы

Ключ API необходим для обработки запросов системой. Как только пользователь регистрируется, для него автоматически генерируется ключ API. Ключ API должен отправляться с каждым запросом (см. полный пример ниже). Если ключ API не отправлен или срок его действия истек, произойдет ошибка. Пожалуйста, держите свой ключ API в секрете, чтобы предотвратить злоупотребление.

###### Аутентификация

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

cURL
PHP
Node.js
Python
C#

```
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());
```

###### Ограничение скорости

Наш API имеет ограничитель скорости для защиты от пиковых запросов для обеспечения максимальной стабильности. В настоящее время наш ограничитель скорости ограничен 30 запросами в 1 минуту. Обратите внимание, что тариф может меняться в зависимости от подписанного плана.

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

```
X-RateLimit-Limit: 30  
X-RateLimit-Remaining: 29  
X-RateLimit-Reset: TIMESTAMP
```

###### Обработка ответов

По умолчанию все ответы API возвращаются в формате JSON. Чтобы преобразовать их в пригодные для использования данные, необходимо использовать соответствующую функцию в соответствии с языком. В PHP функция json\_decode() может использоваться для преобразования данных либо в объект (по умолчанию), либо в массив (установите второй параметр в true). Очень важно проверить ключ ошибки, так как он предоставляет информацию о том, была ли ошибка или нет. Вы также можете проверить код заголовка.

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

---

#### Счет - Open in ChatGPT - Open in Claude

###### Получить аккаунт

ПОЛУЧИТЬ  `https://urlkai.com/api/account`

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

cURL
PHP
Node.js
Python
C#

```
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"
    }
}
```

###### Обновить учетную запись

КЛАСТЬ  `https://urlkai.com/api/account/update`

Чтобы обновить информацию по аккаунту, вы можете отправить запрос на этот эндпоинт и он обновит данные по аккаунту.

cURL
PHP
Node.js
Python
C#

```
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": "Аккаунт успешно обновлен."
}
```

---

#### Брендированные домены - Open in ChatGPT - Open in Claude

###### Список брендированных доменов

ПОЛУЧИТЬ  `https://urlkai.com/api/domains?limit=2&page=1`

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

| **Параметр** | **Описание** |
| --- | --- |
| предел | (необязательно) Постраничный результат данных |
| страница | (необязательно) Запрос текущей страницы |

cURL
PHP
Node.js
Python
C#

```
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"
            }
        ]
    }
}
```

###### Создание брендированного домена

ПОМЕСТИТЬ  `https://urlkai.com/api/domain/add`

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

| **Параметр** | **Описание** |
| --- | --- |
| домен | (обязательно) Брендированный домен, включающий http или https |
| redirectroot | (необязательно) Корневая переадресация при посещении вашего домена |
| редирект404 | (необязательно) Пользовательский редирект 404 |

cURL
PHP
Node.js
Python
C#

```
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
}
```

###### Обновить домен

КЛАСТЬ  `https://urlkai.com/api/domain/:id/update`

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

| **Параметр** | **Описание** |
| --- | --- |
| redirectroot | (необязательно) Корневая переадресация при посещении вашего домена |
| редирект404 | (необязательно) Пользовательский редирект 404 |

cURL
PHP
Node.js
Python
C#

```
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": "Домен успешно обновлен."
}
```

###### Удалить домен

УДАЛИТЬ  `https://urlkai.com/api/domain/:id/delete`

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

cURL
PHP
Node.js
Python
C#

```
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": "Домен успешно удален."
}
```

---

#### Оверлеи CTA - Open in ChatGPT - Open in Claude

###### Список оверлеев CTA

ПОЛУЧИТЬ  `https://urlkai.com/api/overlay?limit=2&page=1`

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

| **Параметр** | **Описание** |
| --- | --- |
| предел | (необязательно) Постраничный результат данных |
| страница | (необязательно) Запрос текущей страницы |

cURL
PHP
Node.js
Python
C#

```
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"
            }
        ]
    }
}
```

---

#### Кампании - Open in ChatGPT - Open in Claude

###### Список кампаний

ПОЛУЧИТЬ  `https://urlkai.com/api/campaigns?limit=2&page=1`

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

| **Параметр** | **Описание** |
| --- | --- |
| предел | (необязательно) Постраничный результат данных |
| страница | (необязательно) Запрос текущей страницы |

cURL
PHP
Node.js
Python
C#

```
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"
            }
        ]
    }
}
```

###### Создать кампанию

ПОМЕСТИТЬ  `https://urlkai.com/api/campaign/add`

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

| **Параметр** | **Описание** |
| --- | --- |
| имя | (необязательно) Название кампании |
| слизняк | (необязательно) Вращательный слаг |
| общественный | (необязательно) Доступ |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    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 => 
        '{
	    "name": "New Campaign",
	    "slug": "new-campaign",
	    "public": true
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
```

```
import requests
url = "https://urlkai.com/api/campaign/add"
payload = {
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}
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/campaign/add");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "New Campaign",
    "slug": "new-campaign",
    "public": true
}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

###### Ответ сервера

```
{
    «ошибка»: 0,
    "id": 3,
    «домен»: «Новая кампания»,
    «публичный»: верно,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
}
```

###### Назначение ссылки на кампанию

ПОМЕСТИТЬ  `https://urlkai.com/api/campaign/:campaignid/assign/:linkid`

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

cURL
PHP
Node.js
Python
C#

```
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": "Ссылка успешно добавлена в рассылку."
}
```

###### Кампания по обновлению

КЛАСТЬ  `https://urlkai.com/api/campaign/:id/update`

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

| **Параметр** | **Описание** |
| --- | --- |
| имя | (обязательно) Название кампании |
| слизняк | (необязательно) Вращательный слаг |
| общественный | (необязательно) Доступ |

cURL
PHP
Node.js
Python
C#

```
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"
}
```

###### Удалить кампанию

УДАЛИТЬ  `https://urlkai.com/api/campaign/:id/delete`

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

cURL
PHP
Node.js
Python
C#

```
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": "Кампания успешно удалена."
}
```

---

#### Каналами - Open in ChatGPT - Open in Claude

###### Список каналов

ПОЛУЧИТЬ  `https://urlkai.com/api/channels?limit=2&page=1`

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

| **Параметр** | **Описание** |
| --- | --- |
| предел | (необязательно) Постраничный результат данных |
| страница | (необязательно) Запрос текущей страницы |

cURL
PHP
Node.js
Python
C#

```
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",
                "В звездах": Ложь
            }
        ]
    }
}
```

###### Список элементов канала

ПОЛУЧИТЬ  `https://urlkai.com/api/channel/:id?limit=1&page=1`

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

| **Параметр** | **Описание** |
| --- | --- |
| предел | (необязательно) Постраничный результат данных |
| страница | (необязательно) Запрос текущей страницы |

cURL
PHP
Node.js
Python
C#

```
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"
            }
        ]
    }
}
```

###### Создание канала

ПОМЕСТИТЬ  `https://urlkai.com/api/channel/add`

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

| **Параметр** | **Описание** |
| --- | --- |
| имя | (обязательно) Название канала |
| описание | (необязательно) Описание канала |
| Цвет | (необязательно) Цвет значка канала (HEX) |
| усеянный | (необязательно) Помечать канал звездочкой или нет (верно или ложно) |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    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 => 
        '{
	    "name": "New Channel",
	    "description": "my new channel",
	    "color": "#000000",
	    "starred": true
	}',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/add',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
```

```
import requests
url = "https://urlkai.com/api/channel/add"
payload = {
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}
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/channel/add");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "New Channel",
    "description": "my new channel",
    "color": "#000000",
    "starred": true
}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

###### Ответ сервера

```
{
    «ошибка»: 0,
    "id": 3,
    «название»: «Новый канал»,
    «описание»: «мой новый канал»,
    "color": "#000000",
    «starred»: правда
}
```

###### Назначение элемента каналу

ПОМЕСТИТЬ  `https://urlkai.com/api/channel/:channelid/assign/:type/:itemid`

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

| **Параметр** | **Описание** |
| --- | --- |
| :channelid | (обязательно) Идентификатор канала |
| :тип | (обязательные) ссылки или биография или QR |
| :itemid | (обязательно) ID элемента |

cURL
PHP
Node.js
Python
C#

```
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": "Товар успешно добавлен в канал."
}
```

###### Канал обновлений

КЛАСТЬ  `https://urlkai.com/api/channel/:id/update`

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

| **Параметр** | **Описание** |
| --- | --- |
| имя | (необязательно) Название канала |
| описание | (необязательно) Описание канала |
| Цвет | (необязательно) Цвет значка канала (HEX) |
| усеянный | (необязательно) Помечать канал звездочкой или нет (верно или ложно) |

cURL
PHP
Node.js
Python
C#

```
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": "Канал успешно обновлен."
}
```

###### Удалить канал

УДАЛИТЬ  `https://urlkai.com/api/channel/:id/delete`

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

cURL
PHP
Node.js
Python
C#

```
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": "Канал успешно удален."
}
```

---

#### Пользовательский всплеск - Open in ChatGPT - Open in Claude

###### Список пользовательских заставок

ПОЛУЧИТЬ  `https://urlkai.com/api/splash?limit=2&page=1`

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

| **Параметр** | **Описание** |
| --- | --- |
| предел | (необязательно) Постраничный результат данных |
| страница | (необязательно) Запрос текущей страницы |

cURL
PHP
Node.js
Python
C#

```
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"
            }
        ]
    }
}
```

---

#### Файлы - Open in ChatGPT - Open in Claude

###### Список файлов

ПОЛУЧИТЬ  `https://urlkai.com/api/files?limit=2&page=1`

Получите все свои файлы. Вы также можете искать по имени.

| **Параметр** | **Описание** |
| --- | --- |
| имя | (необязательно) Поиск файла по имени |
| предел | (необязательно) Постраничный результат данных |
| страница | (необязательно) Запрос текущей страницы |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
```

```
$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/files?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
```

```
import requests
url = "https://urlkai.com/api/files?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)
```

```
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/files?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

###### Ответ сервера

```
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/zMdzF",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/adokz",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/qjlvz",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
```

###### Загрузить файл

ПОМЕСТИТЬ  `https://urlkai.com/api/files/upload/:filename?name=My+File`

Загрузите файл, отправив двоичные данные в качестве тела сообщения. Вам нужно отправить имя файла с расширением вместо :filename в URL (например, brandkit.zip). Вы можете задать параметры, отправив следующие параметры.

| **Параметр** | **Описание** |
| --- | --- |
| имя | (необязательно) Имя файла |
| обычай | (необязательно) Пользовательский псевдоним вместо случайного псевдонима. |
| домен | (необязательно) Пользовательский домен |
| пароль | (необязательно) Защита паролем |
| истечение | (необязательно) Срок действия примера для скачивания 2021-09-28 |
| максзагрузок | (необязательно) Максимальное количество загрузок |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'
```

```
$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
```

```
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/files/upload/:filename?name=My+File',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify("BINARY DATA"),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
```

```
import requests
url = "https://urlkai.com/api/files/upload/:filename?name=My+File"
payload = "BINARY DATA"
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)
```

```
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/files/upload/:filename?name=My+File");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent(""BINARY DATA"", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

###### Ответ сервера

```
{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/urlkai.com\/fkEUs"
}
```

---

#### Дюны - Open in ChatGPT - Open in Claude

###### Список ссылок

ПОЛУЧИТЬ  `https://urlkai.com/api/urls?limit=2&page=1o=date`

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

| **Параметр** | **Описание** |
| --- | --- |
| предел | (необязательно) Постраничный результат данных |
| страница | (необязательно) Запрос текущей страницы |
| порядок | (необязательно) Сортировка данных по дате или клику |
| короткий | (необязательно) Поиск по короткому URL. Обратите внимание, что при использовании параметра short все остальные параметры игнорируются, и в случае совпадения будет возвращен ответ Single Link. |
| q | (необязательно) Поиск ссылок по ключевому слову |

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/urls?limit=2&page=1o=date' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/urls?limit=2&page=1o=date",
    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/urls?limit=2&page=1o=date',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
});
```

```
Запросы на импорт
URL = "https://urlkai.com/api/urls?limit=2&page=1o=date"
полезная нагрузка = {}
заголовки = {
    'Авторизация': 'Предъявитель 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/urls?limit=2&page=1o=date");
просьба. 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,
        "URL-адреса": [
            {
                "id": 2,
                "alias": "google",
                "shorturl": "https:\/\/urlkai.com\/google",
                "longurl": "https:\/\/google.com",
                "клики": 0,
                "title": "Google",
                "description": "",
                "Дата": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "alias": "googlecanada",
                "shorturl": "https:\/\/urlkai.com\/googlecanada",
                "longurl": "https:\/\/google.ca",
                "клики": 0,
                "title": "Google Canada,"
                "description": "",
                "Дата": "2020-11-10 18:00:25"
            }
        ]
    }
}
```

###### Получите одну ссылку

ПОЛУЧИТЬ  `https://urlkai.com/api/url/:id`

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

cURL
PHP
Node.js
Python
C#

```
curl --location --request GET 'https://urlkai.com/api/url/:id' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/url/: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/url/: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/url/: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/url/: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,
    "подробности": {
        "id": 1,
        "shorturl": "https:\/\/urlkai.com\/googlecanada",
        "longurl": "https:\/\/google.com",
        "title": "Google",
        "description": "",
        "местоположение": {
            "Канада": "https:\/\/google.ca",
            "Соединенные Штаты": "https:\/\/google.us"
        },
        "устройство": {
            "iphone": "https:\/\/google.com",
            "Android": "https:\/\/google.com"
        },
        "expiry": null,
        "Дата": "2020-11-10 18:01:43"
    },
    "data": {
        "клики": 0,
        "uniqueClicks": 0,
        "topCountries": 0,
        "topReferrers": 0,
        "topBrowsers": 0,
        "topOs": 0,
        "socialCount": {
            "фейсбук": 0,
            "Твиттер": 0,
            "Google": 0
        }
    }
}
```

###### Сокращение ссылки

ПОМЕСТИТЬ  `https://urlkai.com/api/url/add`

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

| **Параметр** | **Описание** |
| --- | --- |
| URL-адрес | (обязательно) Длинный URL для сокращения. |
| обычай | (необязательно) Пользовательский псевдоним вместо случайного псевдонима. |
| тип | (необязательно) Тип перенаправления [direct, frame, splash], только *идентификатор* для пользовательской заставки или *Оверлей-ID* для CTA страниц |
| пароль | (необязательно) Защита паролем |
| домен | (необязательно) Пользовательский домен |
| истечение | (необязательно) Срок действия для примера ссылки: 2021-09-28 23:11:16 |
| геотаргет | (необязательно) Данные геотаргетинга |
| DeviceTarget | (необязательно) Данные таргетинга на устройства |
| languagetarget | (необязательно) Данные языкового таргетинга |
| Метазаголовок | (необязательно) Мета-титул |
| метаописание | (необязательно) Мета-описание |
| Метаобраз | (необязательно) Ссылка на изображение в формате jpg или png |
| описание | (необязательно) Примечание или описание |
| Пикселей | (необязательно) Массив идентификаторов пикселей |
| канал | (необязательно) Идентификатор канала |
| кампания | (необязательно) Идентификатор кампании |
| Deeplink | (по выбору) Объект, содержащий ссылки из магазина приложений. При использовании этого важно также установить таргетирование устройств. (Новое) Теперь можно установить параметр «auto» на true, чтобы автоматически генерировать глубокие ссылки из предоставленной длинной ссылки. |
| статус | (необязательно) *общественный* или *Приватный (по умолчанию)* |

cURL
PHP
Node.js
Python
C#

```
curl --location --request POST 'https://urlkai.com/api/url/add' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "URL": "https:\/\/google.com",
    "status": "частный",
    "custom": "google",
    "password": "mypass",
    "Срок действия": "2020-11-11 12:00:00",
    "type": "всплеск",
    "metatitle": "Не Google",
    "metadescription": "Не описание Google",
    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
    "description": "Для facebook",
    "пиксели": [
        1,
        2,
        3,
        4
    ],
    "канал": 1,
    "кампания": 1,
    "deeplink": {
        "auto": верно,
        "Apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "Геомишень": [
        {
            "location": "Канада",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "Соединенные Штаты",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "устройство": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https:\/\/google.com"
        },
        {
            "language": "fr",
            "link": "https:\/\/google.ca"
        }
    ],
    "параметры": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "устройство": "gtm_source",
            "link": "api"
        }
    ]
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/url/add",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => "ПОЧТА",
    CURLOPT_HTTPHEADER => [
        "Авторизация: Предъявитель YOURAPIKEY",
        "Content-Type: application/json,"
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "URL": "https:\/\/google.com",
	    "status": "частный",
	    "custom": "google",
	    "password": "mypass",
	    "Срок действия": "2020-11-11 12:00:00",
	    "type": "всплеск",
	    "metatitle": "Не Google",
	    "metadescription": "Не описание Google",
	    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
	    "description": "Для facebook",
	    "пиксели": [
	        1,
	        2,
	        3,
	        4
	    ],
	    "канал": 1,
	    "кампания": 1,
	    "deeplink": {
	        "auto": верно,
	        "Apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
	        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
	    },
	    "Геомишень": [
	        {
	            "location": "Канада",
	            "link": "https:\/\/google.ca"
	        },
	        {
	            "location": "Соединенные Штаты",
	            "link": "https:\/\/google.us"
	        }
	    ],
	    "devicetarget": [
	        {
	            "device": "iPhone",
	            "link": "https:\/\/google.com"
	        },
	        {
	            "устройство": "Android",
	            "link": "https:\/\/google.com"
	        }
	    ],
	    "languagetarget": [
	        {
	            "language": "en",
	            "link": "https:\/\/google.com"
	        },
	        {
	            "language": "fr",
	            "link": "https:\/\/google.ca"
	        }
	    ],
	    "параметры": [
	        {
	            "name": "aff",
	            "value": "3"
	        },
	        {
	            "устройство": "gtm_source",
	            "link": "api"
	        }
	    ]
	}',
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response;
```

```
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/url/add',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "URL": "https:\/\/google.com",
    "status": "частный",
    "custom": "google",
    "password": "mypass",
    "Срок действия": "2020-11-11 12:00:00",
    "type": "всплеск",
    "metatitle": "Не Google",
    "metadescription": "Не описание Google",
    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
    "description": "Для facebook",
    "пиксели": [
        1,
        2,
        3,
        4
    ],
    "канал": 1,
    "кампания": 1,
    "deeplink": {
        "auto": верно,
        "Apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "Геомишень": [
        {
            "location": "Канада",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "Соединенные Штаты",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "устройство": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https:\/\/google.com"
        },
        {
            "language": "fr",
            "link": "https:\/\/google.ca"
        }
    ],
    "параметры": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "устройство": "gtm_source",
            "link": "api"
        }
    ]
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
});
```

```
Запросы на импорт
URL = "https://urlkai.com/api/url/add"
полезная нагрузка = {
    "url": "https://google.com",
    "status": "частный",
    "custom": "google",
    "password": "mypass",
    "Срок действия": "2020-11-11 12:00:00",
    "type": "всплеск",
    "metatitle": "Не Google",
    "metadescription": "Не описание Google",
    "metaimage": "https://www.mozilla.org/media/protocol/img/logos/firefox/browser/og.4ad05d4125a5.png",
    "description": "Для facebook",
    "пиксели": [
        1,
        2,
        3,
        4
    ],
    "канал": 1,
    "кампания": 1,
    "deeplink": {
        "auto": верно,
        "яблоко": "https://apps.apple.com/us/app/google/id284815942",
        "google": "https://play.google.com/store/apps/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "Геомишень": [
        {
            "location": "Канада",
            "link": "https://google.ca"
        },
        {
            "location": "Соединенные Штаты",
            "link": "https://google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https://google.com"
        },
        {
            "устройство": "Android",
            "link": "https://google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https://google.com"
        },
        {
            "language": "fr",
            "link": "https://google.ca"
        }
    ],
    "параметры": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "устройство": "gtm_source",
            "link": "api"
        }
    ]
}
заголовки = {
    'Авторизация': 'Предъявитель 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/url/add");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "URL": "https:\/\/google.com",
    "status": "частный",
    "custom": "google",
    "password": "mypass",
    "Срок действия": "2020-11-11 12:00:00",
    "type": "всплеск",
    "metatitle": "Не Google",
    "metadescription": "Не описание Google",
    "metaimage": "https:\/\/www.mozilla.org\/media\/protocol\/img\/logos\/firefox\/browser\/og.4ad05d4125a5.png",
    "description": "Для facebook",
    "пиксели": [
        1,
        2,
        3,
        4
    ],
    "канал": 1,
    "кампания": 1,
    "deeplink": {
        "auto": верно,
        "Apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "Геомишень": [
        {
            "location": "Канада",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "Соединенные Штаты",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "устройство": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "languagetarget": [
        {
            "language": "en",
            "link": "https:\/\/google.com"
        },
        {
            "language": "fr",
            "link": "https:\/\/google.ca"
        }
    ],
    "параметры": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "устройство": "gtm_source",
            "link": "api"
        }
    ]
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync());
```

###### Ответ сервера

```
{
    "ошибка": 0,
    "id": 3,
    "shorturl": "https:\/\/urlkai.com\/google"
}
```

###### Ссылка на обновление

КЛАСТЬ  `https://urlkai.com/api/url/:id/update`

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

| **Параметр** | **Описание** |
| --- | --- |
| URL-адрес | (обязательно) Длинный URL для сокращения. |
| обычай | (необязательно) Пользовательский псевдоним вместо случайного псевдонима. |
| тип | (необязательно) Тип перенаправления [прямой, кадровый, заставка] |
| пароль | (необязательно) Защита паролем |
| домен | (необязательно) Пользовательский домен |
| истечение | (необязательно) Срок действия для примера ссылки: 2021-09-28 23:11:16 |
| геотаргет | (необязательно) Данные геотаргетинга |
| DeviceTarget | (необязательно) Данные таргетинга на устройства |
| languagetarget | (необязательно) Данные языкового таргетинга |
| Метазаголовок | (необязательно) Мета-титул |
| метаописание | (необязательно) Мета-описание |
| Метаобраз | (необязательно) Ссылка на изображение в формате jpg или png |
| Пикселей | (необязательно) Массив идентификаторов пикселей |
| канал | (необязательно) Идентификатор канала |
| кампания | (необязательно) Идентификатор кампании |
| Deeplink | (необязательно) Объект, содержащий ссылки на магазин приложений. При использовании этого параметра важно также настроить таргетинг на устройство. |

cURL
PHP
Node.js
Python
C#

```
curl --location --request PUT 'https://urlkai.com/api/url/:id/update' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
--data-raw '{
    "URL": "https:\/\/google.com",
    "custom": "google",
    "password": "mypass",
    "Срок действия": "2020-11-11 12:00:00",
    "type": "всплеск",
    "пиксели": [
        1,
        2,
        3,
        4
    ],
    "канал": 1,
    "deeplink": {
        "Apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "Геомишень": [
        {
            "location": "Канада",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "Соединенные Штаты",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "устройство": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "параметры": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "устройство": "gtm_source",
            "link": "api"
        }
    ]
}'
```

```
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/url/: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 => 
        '{
	    "URL": "https:\/\/google.com",
	    "custom": "google",
	    "password": "mypass",
	    "Срок действия": "2020-11-11 12:00:00",
	    "type": "всплеск",
	    "пиксели": [
	        1,
	        2,
	        3,
	        4
	    ],
	    "канал": 1,
	    "deeplink": {
	        "Apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
	        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
	    },
	    "Геомишень": [
	        {
	            "location": "Канада",
	            "link": "https:\/\/google.ca"
	        },
	        {
	            "location": "Соединенные Штаты",
	            "link": "https:\/\/google.us"
	        }
	    ],
	    "devicetarget": [
	        {
	            "device": "iPhone",
	            "link": "https:\/\/google.com"
	        },
	        {
	            "устройство": "Android",
	            "link": "https:\/\/google.com"
	        }
	    ],
	    "параметры": [
	        {
	            "name": "aff",
	            "value": "3"
	        },
	        {
	            "устройство": "gtm_source",
	            "link": "api"
	        }
	    ]
	}',
));

$response = curl_exec($curl);

curl_close($curl);
эхо $response;
```

```
var request = require('request');
var options = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/url/:id/update',
    'headers': {
        'Авторизация': 'Предъявитель YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    тело: JSON.stringify({
    "URL": "https:\/\/google.com",
    "custom": "google",
    "password": "mypass",
    "Срок действия": "2020-11-11 12:00:00",
    "type": "всплеск",
    "пиксели": [
        1,
        2,
        3,
        4
    ],
    "канал": 1,
    "deeplink": {
        "Apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "Геомишень": [
        {
            "location": "Канада",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "Соединенные Штаты",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "устройство": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "параметры": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "устройство": "gtm_source",
            "link": "api"
        }
    ]
}),
};
request(options, function (ошибка, ответ) {
    if (error) throw new Error(error);
    console.log(response.body);
});
```

```
Запросы на импорт
URL = "https://urlkai.com/api/url/:id/update"
полезная нагрузка = {
    "url": "https://google.com",
    "custom": "google",
    "password": "mypass",
    "Срок действия": "2020-11-11 12:00:00",
    "type": "всплеск",
    "пиксели": [
        1,
        2,
        3,
        4
    ],
    "канал": 1,
    "deeplink": {
        "яблоко": "https://apps.apple.com/us/app/google/id284815942",
        "google": "https://play.google.com/store/apps/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "Геомишень": [
        {
            "location": "Канада",
            "link": "https://google.ca"
        },
        {
            "location": "Соединенные Штаты",
            "link": "https://google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https://google.com"
        },
        {
            "устройство": "Android",
            "link": "https://google.com"
        }
    ],
    "параметры": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "устройство": "gtm_source",
            "link": "api"
        }
    ]
}
заголовки = {
    'Авторизация': 'Предъявитель 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/url/:id/update");
просьба. Headers.Add("Авторизация", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "URL": "https:\/\/google.com",
    "custom": "google",
    "password": "mypass",
    "Срок действия": "2020-11-11 12:00:00",
    "type": "всплеск",
    "пиксели": [
        1,
        2,
        3,
        4
    ],
    "канал": 1,
    "deeplink": {
        "Apple": "https:\/\/apps.apple.com\/us\/app\/google\/id284815942",
        "google": "https:\/\/play.google.com\/store\/apps\/details?id=com.google.android.googlequicksearchbox&hl=en_CA≷=US"
    },
    "Геомишень": [
        {
            "location": "Канада",
            "link": "https:\/\/google.ca"
        },
        {
            "location": "Соединенные Штаты",
            "link": "https:\/\/google.us"
        }
    ],
    "devicetarget": [
        {
            "device": "iPhone",
            "link": "https:\/\/google.com"
        },
        {
            "устройство": "Android",
            "link": "https:\/\/google.com"
        }
    ],
    "параметры": [
        {
            "name": "aff",
            "value": "3"
        },
        {
            "устройство": "gtm_source",
            "link": "api"
        }
    ]
}", System.Text.Encoding.UTF8, "application/json");
просьба. Content = содержимое;
var response = ожидать клиента. SendAsync(запрос);
ответ. EnsureSuccessStatusCode();
Console.WriteLine(ожидание ответа. Content.ReadAsStringAsync());
```

###### Ответ сервера

```
{
    "ошибка": 0,
    "id": 3,
    "короткий": "https:\/\/urlkai.com\/google"
}
```

###### Удаление ссылки

УДАЛИТЬ  `https://urlkai.com/api/url/:id/delete`

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

cURL
PHP
Node.js
Python
C#

```
curl --location --request DELETE 'https://urlkai.com/api/url/:id/delete' \
--заголовок 'Авторизация: Bearer YOURAPIKEY' \
--заголовок 'Content-Type: application/json' \
```

```
$curl = curl_init();

curl_setopt_array($curl, массив(
    CURLOPT_URL => "https://urlkai.com/api/url/: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/url/: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/url/: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/url/: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": "Ссылка успешно удалена"
}
```

---

#### Пикселей - Open in ChatGPT - Open in Claude

###### Список пикселей

ПОЛУЧИТЬ  `https://urlkai.com/api/pixels?limit=2&page=1`

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

| **Параметр** | **Описание** |
| --- | --- |
| предел | (необязательно) Постраничный результат данных |
| страница | (необязательно) Запрос текущей страницы |

cURL
PHP
Node.js
Python
C#

```
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"
            }
        ]
    }
}
```

###### Создание пикселя

ПОМЕСТИТЬ  `https://urlkai.com/api/pixel/add`

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

| **Параметр** | **Описание** |
| --- | --- |
| тип | (обязательно) gtmpixel | Гапиксель | FBPIXEL | adwordspixel | linkedinpixel | Твиттерпиксель | adrollpixel | Кворапиксель | Пинтерест | Бинг | Снэпчат | Реддит | Тикток |
| имя | (обязательно) Пользовательское имя для пикселя |
| ярлык | (обязательно) Тег для пикселя |

cURL
PHP
Node.js
Python
C#

```
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
}
```

###### Обновление пикселя

КЛАСТЬ  `https://urlkai.com/api/pixel/:id/update`

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

| **Параметр** | **Описание** |
| --- | --- |
| имя | (необязательно) Пользовательское имя для пикселя |
| ярлык | (обязательно) Тег для пикселя |

cURL
PHP
Node.js
Python
C#

```
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": "Пиксель успешно обновился."
}
```

###### Удалить пиксель

УДАЛИТЬ  `https://urlkai.com/api/pixel/:id/delete`

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

cURL
PHP
Node.js
Python
C#

```
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-коды - Open in ChatGPT - Open in Claude

###### Список QR-кодов

ПОЛУЧИТЬ  `https://urlkai.com/api/qr?limit=2&page=1`

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

| **Параметр** | **Описание** |
| --- | --- |
| предел | (необязательно) Постраничный результат данных |
| страница | (необязательно) Запрос текущей страницы |

cURL
PHP
Node.js
Python
C#

```
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"
            }
        ]
    }
}
```

###### Получите один QR-код

ПОЛУЧИТЬ  `https://urlkai.com/api/qr/:id`

Чтобы получить сведения об одном QR-коде через API, вы можете использовать эту конечную точку.

cURL
PHP
Node.js
Python
C#

```
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-кода

ПОМЕСТИТЬ  `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
PHP
Node.js
Python
C#

```
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-код

КЛАСТЬ  `https://urlkai.com/api/qr/:id/update`

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

| **Параметр** | **Описание** |
| --- | --- |
| данные | (обязательно) Данные должны быть встроены в QR-код. Данные могут быть строковыми или массивными в зависимости от типа |
| фон | (необязательно) Цвет RGB, например, rgb (255,255,255) |
| передний план | (необязательно) Цвет RGB, например, rgb(0,0,0) |
| лого | (необязательно) Путь к логотипу либо png, либо jpg |

cURL
PHP
Node.js
Python
C#

```
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-кода

УДАЛИТЬ  `https://urlkai.com/api/qr/:id/delete`

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

cURL
PHP
Node.js
Python
C#

```
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-код был успешно удален."
}
```