È necessaria una chiave API affinché le richieste vengano elaborate dal sistema. Una volta che un utente si registra, viene generata automaticamente una chiave API per questo utente. La chiave API deve essere inviata con ogni richiesta (vedi esempio completo di seguito). Se la chiave API non viene inviata o è scaduta, si verificherà un errore. Assicurati di mantenere segreta la tua chiave API per prevenire abusi.
Per autenticarti con il sistema API, devi inviare la tua chiave API come token di autorizzazione con ogni richiesta. Puoi vedere il codice di esempio di seguito.
curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/account",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЩА",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl); var request = require('request');
var options = {
"метод": "ПОЩА",
'url': 'https://urlkai.com/api/account',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
тяло: ''
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/account"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); La nostra API ha un limitatore di velocità per salvaguardare da picchi di richieste per massimizzarne la stabilità. Il nostro limitatore di velocità è attualmente limitato a 30 richieste al 1 minuto. Моля, имайте предвид, че тарифата може да се промени в зависимост от абонаментния план.
Insieme alla risposta verranno inviate diverse intestazioni che possono essere esaminate per determinare varie informazioni sulla richiesta.
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Tutte le risposte API vengono restituite in formato JSON per impostazione predefinita. Per convertirli in dati utilizzabili, sarà necessario utilizzare la funzione appropriata in base alla lingua. In PHP, la funzione json_decode() può essere utilizzata per convertire i dati in un oggetto (predefinito) o in un array (impostare il secondo parametro su true). È molto importante controllare la chiave di errore in quanto fornisce informazioni sull'eventuale presenza di un errore. Puoi anche controllare il codice dell'intestazione.
{
"error": 1,
"message": "An error occurred"
}https://urlkai.com/api/account
Per ottenere informazioni sull'account, puoi inviare una richiesta a questo endpoint che restituirà i dati sull'account.
curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/account",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/account',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/account"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"данни": {
"id": 1,
"имейл": " [имейл защитен] ",
"username": "sampleuser",
"avatar": "https:\/\/domain.com\/content\/avatar.png",
"status": "pro",
"изтича": "2022-11-15 15:00:00",
"Регистриран": "2020-11-10 18:01:43"
}
} https://urlkai.com/api/account/update
Per aggiornare le informazioni sull'account, puoi inviare una richiesta a questo endpoint che aggiornerà i dati sull'account.
curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"имейл": " [имейл защитен] ",
"password": "newpassword"
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/account/update",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"имейл": " [имейл защитен] ",
"password": "newpassword"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "PUT",
'url': 'https://urlkai.com/api/account/update',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"имейл": " [имейл защитен] ",
"password": "newpassword"
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/account/update"
полезен товар = {
"имейл": " [имейл защитен] ",
"password": "newpassword"
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"имейл": " [имейл защитен] ",
"password": "newpassword"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "Акаунтът е актуализиран успешно."
} https://urlkai.com/api/campaigns?limit=2&page=1
За да получите кампаниите си чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| граница | (по избор) Резултат от данните за страница |
| страница | (по избор) Заявка за текуща страница |
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"error": "0",
"данни": {
"резултат": 2,
"perpage": 2,
"currentpage": 1,
"следваща страница": 1,
"maxpage": 1,
"кампании": [
{
"id": 1,
"name": "Примерна кампания",
"public": невярно,
"ротатор": невярно,
"list": "https:\/\/domain.com\/u\/admin\/list-1"
},
{
"id": 2,
"домейн": "Кампания във Facebook",
"public": вярно,
"rotator": "https:\/\/domain.com\/r\/test",
"list": "https:\/\/domain.com\/u\/admin\/test-2"
}
]
}
} https://urlkai.com/api/campaign/add
С помощта на тази крайна точка може да се добави кампания.
| Параметро | Описание |
|---|---|
| Име | (по избор) Име на кампанията |
| плужек | (по избор) Ротаторен охлюв |
| общественост | (по избор) Достъп |
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"name": "Нова кампания",
"slug": "нова кампания",
"Публичен": вярно
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/campaign/add",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЩА",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Нова кампания",
"slug": "нова кампания",
"Публичен": вярно
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ПОЩА",
'url': 'https://urlkai.com/api/campaign/add',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"name": "Нова кампания",
"slug": "нова кампания",
"Публичен": вярно
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/campaign/add"
полезен товар = {
"name": "Нова кампания",
"slug": "нова кампания",
"Публичен": вярно
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"name": "Нова кампания",
"slug": "нова кампания",
"Публичен": вярно
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"id": 3,
"domain": "Нова кампания",
"public": вярно,
"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 --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЩА",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ПОЩА",
'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "Връзката е успешно добавена към кампанията."
} https://urlkai.com/api/campaign/:id/update
За да актуализирате кампания, трябва да изпратите валидни данни в JSON чрез PUT заявка. Данните трябва да бъдат изпратени като необработен текст на вашата заявка, както е показано по-долу. Примерът по-долу показва всички параметри, които можете да изпратите, но не сте длъжни да изпращате всички (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| Име | (задължително) Име на кампанията |
| плужек | (по избор) Ротаторен охлюв |
| общественост | (по избор) Достъп |
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"name": "Кампания в Twitter",
"slug": "кампания в Twitter",
"Публичен": вярно
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Кампания в Twitter",
"slug": "кампания в Twitter",
"Публичен": вярно
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "PUT",
'url': 'https://urlkai.com/api/campaign/:id/update',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"name": "Кампания в Twitter",
"slug": "кампания в Twitter",
"Публичен": вярно
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/campaign/:id/update"
полезен товар = {
"name": "Кампания в Twitter",
"slug": "кампания в Twitter",
"Публичен": вярно
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"name": "Кампания в Twitter",
"slug": "кампания в Twitter",
"Публичен": вярно
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"id": 3,
"domain": "Кампания в Twitter",
"public": вярно,
"rotator": "https:\/\/domain.com\/r\/twitter-campaign",
"list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} https://urlkai.com/api/campaign/:id/delete
За да изтриете кампания, трябва да изпратите заявка за изтриване.
curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ИЗТРИВАНЕ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ИЗТРИВАНЕ",
'url': 'https://urlkai.com/api/campaign/:id/delete',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/campaign/:id/delete"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "Кампанията е изтрита успешно."
} https://urlkai.com/api/channels?limit=2&page=1
За да получите каналите си чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| граница | (по избор) Резултат от данните за страница |
| страница | (по избор) Заявка за текуща страница |
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/channels?limit=2&page=1',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/channels?limit=2&page=1"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"error": "0",
"данни": {
"резултат": 2,
"perpage": 2,
"currentpage": 1,
"следваща страница": 1,
"maxpage": 1,
"канали": [
{
"id": 1,
"name": "Канал 1",
"description": "Описание на канал 1",
"color": "#000000",
"Със звезда": Вярно
},
{
"id": 2,
"name": "Канал 2",
"description": "Описание на канал 2",
"color": "#FF0000",
"със звезда": фалшиво
}
]
}
} https://urlkai.com/api/channel/:id?limit=1&page=1
За да получите елементи в избрани канали чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| граница | (по избор) Резултат от данните за страница |
| страница | (по избор) Заявка за текуща страница |
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"error": "0",
"данни": {
"резултат": 2,
"perpage": 2,
"currentpage": 1,
"следваща страница": 1,
"maxpage": 1,
"предмети": [
{
"type": "връзки",
"id": 1,
"title": "Моята примерна връзка",
"preview": "https:\/\/google.com",
"link": "https:\/\/urlkai.com\/google",
"дата": "2022-05-12"
},
{
"type": "bio",
"id": 1,
"title": "Моята примерна биография",
"preview": "https:\/\/urlkai.com\/mybio",
"link": "https:\/\/urlkai.com\/mybio",
"дата": "2022-06-01"
}
]
}
} https://urlkai.com/api/channel/add
С помощта на тази крайна точка може да се добави канал.
| Параметро | Описание |
|---|---|
| Име | (задължително) Име на канала |
| описание | (по избор) Описание на канала |
| цвят | (по избор) Цвят на значката на канала (HEX) |
| Участва | (по избор) Звезда на канала или не (вярно или невярно) |
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"name": "Нов канал",
"description": "Моят нов канал",
"color": "#000000",
"Със звезда": Вярно
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/channel/add",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЩА",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"name": "Нов канал",
"description": "Моят нов канал",
"color": "#000000",
"Със звезда": Вярно
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ПОЩА",
'url': 'https://urlkai.com/api/channel/add',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"name": "Нов канал",
"description": "Моят нов канал",
"color": "#000000",
"Със звезда": Вярно
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/channel/add"
полезен товар = {
"name": "Нов канал",
"description": "Моят нов канал",
"color": "#000000",
"Със звезда": Вярно
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"name": "Нов канал",
"description": "Моят нов канал",
"color": "#000000",
"Със звезда": Вярно
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"id": 3,
"name": "Нов канал",
"description": "Моят нов канал",
"color": "#000000",
"Със звезда": Вярно
} https://urlkai.com/api/channel/:channelid/assign/:type/:itemid
Артикул може да бъде присвоен към всеки канал чрез изпращане на заявка с идентификатора на канала, вида на артикула (връзки, биография или qr) и идентификатора на артикула.
| Параметро | Описание |
|---|---|
| :channelid | (задължително) Идентификатор на канала |
| :вид | (задължително) връзки или биография или QR |
| :itemid | (задължително) ID на артикула |
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЩА",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ПОЩА",
'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "Елементът е успешно добавен към канала."
} https://urlkai.com/api/channel/:id/update
За да актуализирате канал, трябва да изпратите валидни данни в JSON чрез PUT заявка. Данните трябва да бъдат изпратени като необработен текст на вашата заявка, както е показано по-долу. Примерът по-долу показва всички параметри, които можете да изпратите, но не сте длъжни да изпращате всички (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| Име | (по избор) Име на канала |
| описание | (по избор) Описание на канала |
| цвят | (по избор) Цвят на значката на канала (HEX) |
| Участва | (по избор) Звезда на канала или не (вярно или невярно) |
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"име": "Acme Corp",
"description": "канал за артикули за Acme Corp",
"color": "#FFFFFF",
"със звезда": фалшиво
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"име": "Acme Corp",
"description": "канал за артикули за Acme Corp",
"color": "#FFFFFF",
"със звезда": фалшиво
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "PUT",
'url': 'https://urlkai.com/api/channel/:id/update',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"име": "Acme Corp",
"description": "канал за артикули за Acme Corp",
"color": "#FFFFFF",
"със звезда": фалшиво
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/channel/:id/update"
полезен товар = {
"име": "Acme Corp",
"description": "канал за артикули за Acme Corp",
"color": "#FFFFFF",
"със звезда": фалшиво
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"име": "Acme Corp",
"description": "канал за артикули за Acme Corp",
"color": "#FFFFFF",
"със звезда": фалшиво
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "Каналът е актуализиран успешно."
} https://urlkai.com/api/channel/:id/delete
За да изтриете канал, трябва да изпратите заявка за изтриване. Всички елементи също ще бъдат отменени.
curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ИЗТРИВАНЕ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ИЗТРИВАНЕ",
'url': 'https://urlkai.com/api/channel/:id/delete',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/channel/:id/delete"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "Каналът е изтрит успешно."
} https://urlkai.com/api/qr?limit=2&page=1
Per ottenere i tuoi codici QR tramite l'API, puoi utilizzare questo endpoint. Puoi anche filtrare i dati (vedi tabella per maggiori informazioni).
| Параметро | Описание |
|---|---|
| граница | (по избор) Резултат от данните за страница |
| страница | (по избор) Заявка за текуща страница |
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/qr?limit=2&page=1',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/qr?limit=2&page=1"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"error": "0",
"данни": {
"резултат": 2,
"perpage": 2,
"currentpage": 1,
"следваща страница": 1,
"maxpage": 1,
"QRS": [
{
"id": 2,
"link": "https:\/\/urlkai.com\/qr\/a2d5e",
"сканирания": 0,
"name": "Google",
"Дата": "2020-11-10 18:01:43"
},
{
"id": 1,
"link": "https:\/\/urlkai.com\/qr\/b9edfe",
"сканирания": 5,
"name": "Google Canada",
"дата": "2020-11-10 18:00:25"
}
]
}
} https://urlkai.com/api/qr/:id
Per ottenere i dettagli per un singolo codice QR tramite l'API, puoi utilizzare questo endpoint.
curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/qr/:id",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/qr/:id',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/qr/:id"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"подробности": {
"id": 1,
"link": "https:\/\/urlkai.com\/qr\/b9edfe",
"сканирания": 5,
"name": "Google Canada",
"дата": "2020-11-10 18:00:25"
},
"данни": {
"кликвания": 1,
"uniqueClicks": 1,
"topCountries": {
"Неизвестен": "1"
},
"topReferrers": {
"Директни, имейл и други": "1"
},
"topBrowsers": {
"Chrome": "1"
},
"topOs": {
"Windows 10": "1"
},
"socialCount": {
"Фейсбук": 0,
"Туитър": 0,
"Инстаграм": 0
}
}
} https://urlkai.com/api/qr/add
За да създадете QR код, трябва да изпратите валидни данни в JSON чрез POST заявка. Данните трябва да бъдат изпратени като необработен текст на вашата заявка, както е показано по-долу. Примерът по-долу показва всички параметри, които можете да изпратите, но не сте длъжни да изпращате всички (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| вид | (задължително) текст | VCARD | връзка | Електронна поща | телефон | SMS | WiFi |
| данни | (задължително) Данните, които трябва да бъдат вградени в QR кода. Данните могат да бъдат низови или масивни в зависимост от типа |
| фон | (по избор) RGB цвят, например rgb(255,255,255) |
| преден план | (по избор) RGB цвят, например rgb(0,0,0) |
| лого | (по избор) Път към логото png или jpg |
| Име | (по избор) Име на QR код |
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"type": "връзка",
"data": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"преден план": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png",
"name": "API за QR код"
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/qr/add",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЩА",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"type": "връзка",
"data": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"преден план": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png",
"name": "API за QR код"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ПОЩА",
'url': 'https://urlkai.com/api/qr/add',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"type": "връзка",
"data": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"преден план": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png",
"name": "API за QR код"
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/qr/add"
полезен товар = {
"type": "връзка",
"data": "https://google.com",
"background": "rgb(255,255,255)",
"преден план": "rgb(0,0,0)",
"logo": "https://site.com/logo.png",
"name": "API за QR код"
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"type": "връзка",
"data": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"преден план": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png",
"name": "API за QR код"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"id": 3,
"link": "https:\/\/urlkai.com\/qr\/a58f79"
} https://urlkai.com/api/qr/:id/update
Per aggiornare un codice QR, devi inviare un dato valido in JSON tramite una richiesta PUT. I dati devono essere inviati come corpo grezzo della tua richiesta come mostrato di seguito. L'esempio seguente mostra tutti i parametri che puoi inviare ma non è necessario inviarli tutti (vedi tabella per maggiori informazioni).
| Параметро | Описание |
|---|---|
| данни | (задължително) Данните, които трябва да бъдат вградени в QR кода. Данните могат да бъдат низови или масивни в зависимост от типа |
| фон | (по избор) RGB цвят, например rgb(255,255,255) |
| преден план | (по избор) RGB цвят, например rgb(0,0,0) |
| лого | (по избор) Път към логото png или jpg |
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"type": "връзка",
"data": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"преден план": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png"
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"type": "връзка",
"data": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"преден план": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "PUT",
'url': 'https://urlkai.com/api/qr/:id/update',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"type": "връзка",
"data": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"преден план": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png"
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/qr/:id/update"
полезен товар = {
"type": "връзка",
"data": "https://google.com",
"background": "rgb(255,255,255)",
"преден план": "rgb(0,0,0)",
"logo": "https://site.com/logo.png"
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"type": "връзка",
"data": "https:\/\/google.com",
"background": "rgb(255,255,255)",
"преден план": "rgb(0,0,0)",
"logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "QR е актуализиран успешно."
} https://urlkai.com/api/qr/:id/delete
Per eliminare un codice QR, è necessario inviare una richiesta DELETE.
curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ИЗТРИВАНЕ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ИЗТРИВАНЕ",
'url': 'https://urlkai.com/api/qr/:id/delete',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/qr/:id/delete"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "QR кодът е изтрит успешно."
} https://urlkai.com/api/domains?limit=2&page=1
За да получите вашите маркови домейни чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| граница | (по избор) Резултат от данните за страница |
| страница | (по избор) Заявка за текуща страница |
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/domains?limit=2&page=1',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/domains?limit=2&page=1"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"error": "0",
"данни": {
"резултат": 2,
"perpage": 2,
"currentpage": 1,
"следваща страница": 1,
"maxpage": 1,
"домейни": [
{
"id": 1,
"domain": "https:\/\/domain1.com",
"redirectroot": "https:\/\/rootdomain.com",
"redirect404": "https:\/\/rootdomain.com\/404"
},
{
"id": 2,
"domain": "https:\/\/domain2.com",
"redirectroot": "https:\/\/rootdomain2.com",
"redirect404": "https:\/\/rootdomain2.com\/404"
}
]
}
} https://urlkai.com/api/domain/add
С помощта на тази крайна точка може да се добави домейн. Моля, уверете се, че домейнът е правилно насочен към нашия сървър.
| Параметро | Описание |
|---|---|
| домейн | (задължително) Брандиран домейн, включително http или https |
| Пренасочване | (по избор) Пренасочване на root, когато някой посети домейна ви |
| пренасочване404 | (по избор) Персонализирано 404 пренасочване |
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"domain": "https:\/\/domain1.com",
"redirectroot": "https:\/\/rootdomain.com",
"redirect404": "https:\/\/rootdomain.com\/404"
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/domain/add",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЩА",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"domain": "https:\/\/domain1.com",
"redirectroot": "https:\/\/rootdomain.com",
"redirect404": "https:\/\/rootdomain.com\/404"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ПОЩА",
'url': 'https://urlkai.com/api/domain/add',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"domain": "https:\/\/domain1.com",
"redirectroot": "https:\/\/rootdomain.com",
"redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/domain/add"
полезен товар = {
"domain": "https://domain1.com",
"redirectroot": "https://rootdomain.com",
"redirect404": "https://rootdomain.com/404"
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"domain": "https:\/\/domain1.com",
"redirectroot": "https:\/\/rootdomain.com",
"redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"id": 1
} https://urlkai.com/api/domain/:id/update
За да актуализирате брандиран домейн, трябва да изпратите валидни данни в JSON чрез PUT заявка. Данните трябва да бъдат изпратени като необработен текст на вашата заявка, както е показано по-долу. Примерът по-долу показва всички параметри, които можете да изпратите, но не сте длъжни да изпращате всички (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| Пренасочване | (по избор) Пренасочване на root, когато някой посети домейна ви |
| пренасочване404 | (по избор) Персонализирано 404 пренасочване |
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"redirectroot": "https:\/\/rootdomain-new.com",
"redirect404": "https:\/\/rootdomain-new.com\/404"
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"redirectroot": "https:\/\/rootdomain-new.com",
"redirect404": "https:\/\/rootdomain-new.com\/404"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "PUT",
'url': 'https://urlkai.com/api/domain/:id/update',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"redirectroot": "https:\/\/rootdomain-new.com",
"redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/domain/:id/update"
полезен товар = {
"redirectroot": "https://rootdomain-new.com",
"redirect404": "https://rootdomain-new.com/404"
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"redirectroot": "https:\/\/rootdomain-new.com",
"redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "Домейнът е актуализиран успешно."
} https://urlkai.com/api/domain/:id/delete
За да изтриете домейн, трябва да изпратите заявка за изтриване.
curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ИЗТРИВАНЕ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ИЗТРИВАНЕ",
'url': 'https://urlkai.com/api/domain/:id/delete',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/domain/:id/delete"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "Домейнът е изтрит успешно."
} https://urlkai.com/api/urls?limit=2&page=1o=date
Per ottenere i tuoi collegamenti tramite l'API, puoi utilizzare questo endpoint. Puoi anche filtrare i dati (vedi tabella per maggiori informazioni).
| Параметро | Описание |
|---|---|
| граница | (по избор) Резултат от данните за страница |
| страница | (по избор) Заявка за текуща страница |
| заповед | (по избор) Сортиране на данни между дата или щракване |
| къс | (по избор) Търсете с помощта на краткия URL адрес. Имайте предвид, че когато използвате краткия параметър, всички останали параметри се игнорират и ако има съвпадение, ще бъде върнат отговор с една връзка. |
| q | (по избор) Търсене на връзки по ключова дума |
curl --location --request GET 'https://urlkai.com/api/urls?limit=2&page=1o=date' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/urls?limit=2&page=1o=date",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/urls?limit=2&page=1o=date',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
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=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/urls?limit=2&page=1o=date");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"error": "0",
"данни": {
"резултат": 2,
"perpage": 2,
"currentpage": 1,
"следваща страница": 1,
"maxpage": 1,
"URL адреси": [
{
"id": 2,
"псевдоним": "google",
"shorturl": "https:\/\/urlkai.com\/google",
"longurl": "https:\/\/google.com",
"кликвания": 0,
"title": "Google",
"description": "",
"Дата": "2020-11-10 18:01:43"
},
{
"id": 1,
"псевдоним": "googlecanada",
"shorturl": "https:\/\/urlkai.com\/googlecanada",
"longurl": "https:\/\/google.ca",
"кликвания": 0,
"title": "Google Канада",
"description": "",
"дата": "2020-11-10 18:00:25"
}
]
}
} https://urlkai.com/api/url/:id
Per ottenere i dettagli per un singolo collegamento tramite l'API, puoi utilizzare questo endpoint.
curl --location --request GET 'https://urlkai.com/api/url/:id' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/url/:id",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/url/:id',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/url/:id"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/url/:id");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. 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"
},
"изтичане": нула,
"Дата": "2020-11-10 18:01:43"
},
"данни": {
"кликвания": 0,
"uniqueClicks": 0,
"topCountries": 0,
"topReferrers": 0,
"topBrowsers": 0,
"topOs": 0,
"socialCount": {
"Фейсбук": 0,
"Туитър": 0,
"Google": 0
}
}
} https://urlkai.com/api/url/add
Per abbreviare un collegamento, devi inviare un dato valido in JSON tramite una richiesta POST. I dati devono essere inviati come corpo grezzo della tua richiesta come mostrato di seguito. L'esempio seguente mostra tutti i parametri che puoi inviare ma non è necessario inviarli tutti (vedi tabella per maggiori informazioni).
| Параметро | Описание |
|---|---|
| URL адрес | (задължително) Дълъг URL адрес за съкращаване. |
| обичай | (по избор) Персонализиран псевдоним вместо произволен псевдоним. |
| вид | (по избор) Тип пренасочване [директно, рамка, пръскане], само Ид за персонализирана начална страница или Идентификатор на наслагване За CTA страници |
| парола | (по избор) Защита с парола |
| домейн | (по избор) Персонализиран домейн |
| Изтичане | (по избор) Изтичане на срока на валидност за примера за връзка 2021-09-28 23:11:16 |
| Геотаргет | (по избор) Данни за географско насочване |
| devicetarget | (по избор) Данни за насочване по устройство |
| Езикова цел | (по избор) Данни за езиково насочване |
| метазаглавие | (по избор) Мета заглавие |
| Метаописание | (по избор) Мета описание |
| метаизображение | (по избор) Връзка към jpg или png изображение |
| описание | (по избор) Бележка или описание |
| Пиксела | (по избор) Масив от идентификатори на пиксели |
| канал | (по избор) Идентификатор на канала |
| кампания | (по избор) Идентификационен номер на кампанията |
| Дълбока връзка | (по избор) Обект, съдържащ връзки към магазин за приложения. Когато използвате това, е важно да зададете и насочване към устройството. (Ново) Вече можете да зададете параметъра "auto" на true, за да генерирате автоматично дълбоките връзки от предоставената дълга връзка. |
| статус | (по избор) общественост или частен (по подразбиране) |
curl --location --request POST 'https://urlkai.com/api/url/add' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"url": "https:\/\/google.com",
"status": "частен",
"custom": "google",
"password": "mypass",
"изтичане": "2020-11-11 12:00:00",
"type": "splash",
"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"
},
"geotarget": [
{
"местоположение": "Канада",
"link": "https:\/\/google.ca"
},
{
"местоположение": "Съединени щати",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"устройство": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"език": "en",
"link": "https:\/\/google.com"
},
{
"език": "fr",
"link": "https:\/\/google.ca"
}
],
"параметри": [
{
"име": "aff",
"value": "3"
},
{
"устройство": "gtm_source",
"link": "API"
}
]
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/url/add",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЩА",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"url": "https:\/\/google.com",
"status": "частен",
"custom": "google",
"password": "mypass",
"изтичане": "2020-11-11 12:00:00",
"type": "splash",
"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"
},
"geotarget": [
{
"местоположение": "Канада",
"link": "https:\/\/google.ca"
},
{
"местоположение": "Съединени щати",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"устройство": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"език": "en",
"link": "https:\/\/google.com"
},
{
"език": "fr",
"link": "https:\/\/google.ca"
}
],
"параметри": [
{
"име": "aff",
"value": "3"
},
{
"устройство": "gtm_source",
"link": "API"
}
]
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ПОЩА",
'url': 'https://urlkai.com/api/url/add',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"url": "https:\/\/google.com",
"status": "частен",
"custom": "google",
"password": "mypass",
"изтичане": "2020-11-11 12:00:00",
"type": "splash",
"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"
},
"geotarget": [
{
"местоположение": "Канада",
"link": "https:\/\/google.ca"
},
{
"местоположение": "Съединени щати",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"устройство": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"език": "en",
"link": "https:\/\/google.com"
},
{
"език": "fr",
"link": "https:\/\/google.ca"
}
],
"параметри": [
{
"име": "aff",
"value": "3"
},
{
"устройство": "gtm_source",
"link": "API"
}
]
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
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": "splash",
"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"
},
"geotarget": [
{
"местоположение": "Канада",
"link": "https://google.ca"
},
{
"местоположение": "Съединени щати",
"link": "https://google.us"
}
],
"devicetarget": [
{
"устройство": "iPhone",
"link": "https://google.com"
},
{
"device": "Android",
"link": "https://google.com"
}
],
"languagetarget": [
{
"език": "en",
"link": "https://google.com"
},
{
"език": "fr",
"link": "https://google.ca"
}
],
"параметри": [
{
"име": "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 = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/url/add");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"url": "https:\/\/google.com",
"status": "частен",
"custom": "google",
"password": "mypass",
"изтичане": "2020-11-11 12:00:00",
"type": "splash",
"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"
},
"geotarget": [
{
"местоположение": "Канада",
"link": "https:\/\/google.ca"
},
{
"местоположение": "Съединени щати",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"устройство": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"languagetarget": [
{
"език": "en",
"link": "https:\/\/google.com"
},
{
"език": "fr",
"link": "https:\/\/google.ca"
}
],
"параметри": [
{
"име": "aff",
"value": "3"
},
{
"устройство": "gtm_source",
"link": "API"
}
]
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"id": 3,
"shorturl": "https:\/\/urlkai.com\/google"
} https://urlkai.com/api/url/:id/update
Per aggiornare un collegamento, devi inviare un dato valido in JSON tramite una richiesta PUT. I dati devono essere inviati come corpo grezzo della tua richiesta come mostrato di seguito. L'esempio seguente mostra tutti i parametri che puoi inviare ma non è necessario inviarli tutti (vedi tabella per maggiori informazioni).
| Параметро | Описание |
|---|---|
| URL адрес | (задължително) Дълъг URL адрес за съкращаване. |
| обичай | (по избор) Персонализиран псевдоним вместо произволен псевдоним. |
| вид | (по избор) Тип пренасочване [директно, рамка, пръскане] |
| парола | (по избор) Защита с парола |
| домейн | (по избор) Персонализиран домейн |
| Изтичане | (по избор) Изтичане на срока на валидност за примера за връзка 2021-09-28 23:11:16 |
| Геотаргет | (по избор) Данни за географско насочване |
| devicetarget | (по избор) Данни за насочване по устройство |
| Езикова цел | (по избор) Данни за езиково насочване |
| метазаглавие | (по избор) Мета заглавие |
| Метаописание | (по избор) Мета описание |
| метаизображение | (по избор) Връзка към jpg или png изображение |
| Пиксела | (по избор) Масив от идентификатори на пиксели |
| канал | (по избор) Идентификатор на канала |
| кампания | (по избор) Идентификационен номер на кампанията |
| Дълбока връзка | (по избор) Обект, съдържащ връзки към магазин за приложения. Когато използвате това, е важно да зададете и насочване към устройството. |
curl --location --request PUT 'https://urlkai.com/api/url/:id/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"url": "https:\/\/google.com",
"custom": "google",
"password": "mypass",
"изтичане": "2020-11-11 12:00:00",
"type": "splash",
"пиксели": [
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"
},
"geotarget": [
{
"местоположение": "Канада",
"link": "https:\/\/google.ca"
},
{
"местоположение": "Съединени щати",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"устройство": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"параметри": [
{
"име": "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 => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"url": "https:\/\/google.com",
"custom": "google",
"password": "mypass",
"изтичане": "2020-11-11 12:00:00",
"type": "splash",
"пиксели": [
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"
},
"geotarget": [
{
"местоположение": "Канада",
"link": "https:\/\/google.ca"
},
{
"местоположение": "Съединени щати",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"устройство": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"параметри": [
{
"име": "aff",
"value": "3"
},
{
"устройство": "gtm_source",
"link": "API"
}
]
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "PUT",
'url': 'https://urlkai.com/api/url/:id/update',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"url": "https:\/\/google.com",
"custom": "google",
"password": "mypass",
"изтичане": "2020-11-11 12:00:00",
"type": "splash",
"пиксели": [
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"
},
"geotarget": [
{
"местоположение": "Канада",
"link": "https:\/\/google.ca"
},
{
"местоположение": "Съединени щати",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"устройство": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"параметри": [
{
"име": "aff",
"value": "3"
},
{
"устройство": "gtm_source",
"link": "API"
}
]
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
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": "splash",
"пиксели": [
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"
},
"geotarget": [
{
"местоположение": "Канада",
"link": "https://google.ca"
},
{
"местоположение": "Съединени щати",
"link": "https://google.us"
}
],
"devicetarget": [
{
"устройство": "iPhone",
"link": "https://google.com"
},
{
"device": "Android",
"link": "https://google.com"
}
],
"параметри": [
{
"име": "aff",
"value": "3"
},
{
"устройство": "gtm_source",
"link": "API"
}
]
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/url/:id/update");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"url": "https:\/\/google.com",
"custom": "google",
"password": "mypass",
"изтичане": "2020-11-11 12:00:00",
"type": "splash",
"пиксели": [
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"
},
"geotarget": [
{
"местоположение": "Канада",
"link": "https:\/\/google.ca"
},
{
"местоположение": "Съединени щати",
"link": "https:\/\/google.us"
}
],
"devicetarget": [
{
"устройство": "iPhone",
"link": "https:\/\/google.com"
},
{
"device": "Android",
"link": "https:\/\/google.com"
}
],
"параметри": [
{
"име": "aff",
"value": "3"
},
{
"устройство": "gtm_source",
"link": "API"
}
]
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"id": 3,
"short": "https:\/\/urlkai.com\/google"
} https://urlkai.com/api/url/:id/delete
Per eliminare un collegamento, è necessario inviare una richiesta DELETE.
curl --location --request DELETE 'https://urlkai.com/api/url/:id/delete' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/url/:id/delete",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ИЗТРИВАНЕ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ИЗТРИВАНЕ",
'url': 'https://urlkai.com/api/url/:id/delete',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
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=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/url/:id/delete");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "Връзката е изтрита успешно"
} https://urlkai.com/api/overlay?limit=2&page=1
За да получите cta наслагвания чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| граница | (по избор) Резултат от данните за страница |
| страница | (по избор) Заявка за текуща страница |
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/overlay?limit=2&page=1"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"error": "0",
"данни": {
"резултат": 2,
"perpage": 2,
"currentpage": 1,
"следваща страница": 1,
"maxpage": 1,
"CTA": [
{
"id": 1,
"type": "съобщение",
"name": "Продукт 1 Промоция",
"дата": "2020-11-10 18:00:00"
},
{
"id": 2,
"type": "контакт",
"name": "Страница за контакт",
"дата": "2020-11-10 18:10:00"
}
]
}
} https://urlkai.com/api/pixels?limit=2&page=1
За да получите вашите пикселни кодове чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| граница | (по избор) Резултат от данните за страница |
| страница | (по избор) Заявка за текуща страница |
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/pixels?limit=2&page=1"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"error": "0",
"данни": {
"резултат": 2,
"perpage": 2,
"currentpage": 1,
"следваща страница": 1,
"maxpage": 1,
"пиксели": [
{
"id": 1,
"type": "gtmpixel",
"name": "GTM Pixel",
"tag": "GA-123456789",
"дата": "2020-11-10 18:00:00"
},
{
"id": 2,
"type": "twitterpixel",
"име": "Twitter Pixel",
"tag": "1234567",
"дата": "2020-11-10 18:10:00"
}
]
}
} https://urlkai.com/api/pixel/add
С помощта на тази крайна точка може да се създаде пиксел. Трябва да изпратите типа пиксел и етикета.
| Параметро | Описание |
|---|---|
| вид | (задължително) gtmpixel | гапиксел | fbpixel | AdWordsPixel | LinkedIn | Туитърпиксел | AdrollPixel | Quorapixel | pinterest | Bing | Snapchat | Reddit | ТикТок |
| Име | (задължително) Персонализирано име за пиксела ви |
| етикет | (задължително) Маркерът за пиксела |
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"type": "gtmpixel",
"име": "Моят GTM",
"tag": "GTM-ABCDE"
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/pixel/add",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЩА",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"type": "gtmpixel",
"име": "Моят GTM",
"tag": "GTM-ABCDE"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ПОЩА",
'url': 'https://urlkai.com/api/pixel/add',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"type": "gtmpixel",
"име": "Моят GTM",
"tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/pixel/add"
полезен товар = {
"type": "gtmpixel",
"име": "Моят GTM",
"tag": "GTM-ABCDE"
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"type": "gtmpixel",
"име": "Моят GTM",
"tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"id": 1
} https://urlkai.com/api/pixel/:id/update
За да актуализирате пиксел, трябва да изпратите валидни данни в JSON чрез PUT заявка. Данните трябва да бъдат изпратени като необработен текст на вашата заявка, както е показано по-долу. Примерът по-долу показва всички параметри, които можете да изпратите, но не сте длъжни да изпращате всички (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| Име | (по избор) Персонализирано име за пиксела ви |
| етикет | (задължително) Маркерът за пиксела |
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \
--data-raw '{
"име": "Моят GTM",
"tag": "GTM-ABCDE"
}' $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "СЛОЖИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
CURLOPT_POSTFIELDS =>
'{
"име": "Моят GTM",
"tag": "GTM-ABCDE"
}',
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "PUT",
'url': 'https://urlkai.com/api/pixel/:id/update',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
body: JSON.stringify({
"име": "Моят GTM",
"tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/pixel/:id/update"
полезен товар = {
"име": "Моят GTM",
"tag": "GTM-ABCDE"
}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{
"име": "Моят GTM",
"tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "Pixel е актуализиран успешно."
} https://urlkai.com/api/pixel/:id/delete
За да изтриете пиксел, трябва да изпратите заявка за изтриване.
curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ИЗТРИВАНЕ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
"метод": "ИЗТРИВАНЕ",
'url': 'https://urlkai.com/api/pixel/:id/delete',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/pixel/:id/delete"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"грешка": 0,
"message": "Pixel е изтрит успешно."
} https://urlkai.com/api/splash?limit=2&page=1
За да получите персонализирани начални страници чрез API, можете да използвате тази крайна точка. Можете също да филтрирате данни (вижте таблицата за повече информация).
| Параметро | Описание |
|---|---|
| граница | (по избор) Резултат от данните за страница |
| страница | (по избор) Заявка за текуща страница |
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Упълномощаване: Носител YOURAPIKEY' \
--header 'Тип съдържание: application/json' \ $curl = curl_init();
curl_setopt_array($curl, масив(
CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
CURLOPT_RETURNTRANSFER => вярно,
CURLOPT_MAXREDIRS => 2,
CURLOPT_TIMEOUT => 10,
CURLOPT_FOLLOWLOCATION => вярно,
CURLOPT_CUSTOMREQUEST => "ПОЛУЧИ",
CURLOPT_HTTPHEADER => [
"Упълномощаване: Приносител YOURAPIKEY",
"Тип съдържание: приложение/json",
],
));
$response = curl_exec($curl);
curl_close($curl);
ехо $response; var request = require('request');
var options = {
'method': 'GET',
'url': 'https://urlkai.com/api/splash?limit=2&page=1',
'headers': {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
},
};
request(options, function (error, response) {
ако (грешка) хвърли нов Грешка(грешка);
console.log(response.body);
}); заявки за импорт
url = "https://urlkai.com/api/splash?limit=2&page=1"
полезен товар = {}
заглавия = {
"Разрешение": "Приносител YOURAPIKEY",
'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=полезен товар)
print(response.text) var client = нов HttpClient();
var request = нов HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
молба. Headers.Add("Упълномощаване", "Носител YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
молба. Съдържание = съдържание;
var отговор = очаква клиент. SendAsync(заявка);
отговор. EnsureSuccessStatusCode();
Console.WriteLine(очаквам отговор. Content.ReadAsStringAsync()); {
"error": "0",
"данни": {
"резултат": 2,
"perpage": 2,
"currentpage": 1,
"следваща страница": 1,
"maxpage": 1,
"Splash": [
{
"id": 1,
"name": "Продукт 1 Промоция",
"дата": "2020-11-10 18:00:00"
},
{
"id": 2,
"name": "Продукт 2 Промоция",
"дата": "2020-11-10 18:10:00"
}
]
}
}