開発者向け API リファレンス

Getting Started

An API key is required for requests to be processed by the system. Once a user registers, an API key is automatically generated for this user. The API key must be sent with each request (see full example below). If the API key is not sent or is expired, there will be an error. Please make sure to keep your API key secret to prevent abuse.

Authentication

To authenticate with the API system, you need to send your API key as an authorization token with each request. You can see sample code below.

curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();
curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
));

$response = curl_exec($curl); 
var request = require('request');
var options = {
    "metodă": "POST",
    'url': 'https://urlkai.com/api/account',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: ''
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/account"
sarcină utilă = {}
anteturi = {
  "Autorizație": "Purtătorul YOURAPIKEY",
  'Content-Type': 'application/json'
}
răspuns = requests.request("GET", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Rate Limit

Our API has a rate limiter to safeguard against spike in requests to maximize its stability. Our rate limiter is currently caped at 30 requests per 1 minute. Please note that the rate might change according to the subscribed plan.

Several headers will be sent alongside the response and these can be examined to determine various information about the request.

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Response Handling

All API response are returned in JSON format by default. To convert this into usable data, the appropriate function will need to be used according to the language. In PHP, the function json_decode() can be used to convert the data to either an object (default) or an array (set the second parameter to true). It is very important to check the error key as that provides information on whether there was an error or not. You can also check the header code.

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

Cont

Obțineți cont
GET https://urlkai.com/api/account

Pentru a obține informații despre cont, puteți trimite o solicitare către acest punct final și acesta va returna date despre cont.

curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "GET",
    'url': 'https://urlkai.com/api/account',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/account"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("GET", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "date": {
        "id": 1,
        "e-mail": " [e-mail protejat] ",
        "username": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "expiră": "2022-11-15 15:00:00",
        "Înregistrat": "2020-11-10 18:01:43"
    }
} 
Actualizați contul
PUT https://urlkai.com/api/account/update

Pentru a actualiza informațiile despre cont, puteți trimite o solicitare către acest punct final și acesta va actualiza datele din cont.

curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \
--data-raw '{
    "e-mail": " [e-mail protejat] ",
    "password": "newpassword"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "e-mail": " [e-mail protejat] ",
	    "password": "newpassword"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "PUT",
    'url': 'https://urlkai.com/api/account/update',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: JSON.stringify({
    "e-mail": " [e-mail protejat] ",
    "password": "newpassword"
}),
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/account/update"
sarcina utilă = {
    "e-mail": " [e-mail protejat] ",
    "password": "newpassword"
}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("PUT", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{
    "e-mail": " [e-mail protejat] ",
    "password": "newpassword"
}", System.Text.Encoding.UTF8, "aplicație/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "Contul a fost actualizat cu succes."
} 

Domenii de marcă

Listați domeniile de marcă
GET https://urlkai.com/api/domains?limit=2&page=1

Pentru a obține domeniile de marcă prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Descriere
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "GET",
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/domains?limit=2&page=1"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("GET", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "error": "0",
    "date": {
        "rezultat": 2,
        "perpage": 2,
        "pagina curentă": 1,
        "pagina următoare": 1,
        "maxpage": 1,
        "domenii": [
            {
                "id": 1,
                "domeniu": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "id": 2,
                "domeniu": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
} 
Creați un domeniu de marcă
POST https://urlkai.com/api/domain/add

Un domeniu poate fi adăugat folosind acest punct final. Vă rugăm să vă asigurați că domeniul este direcționat corect către serverul nostru.

Parametru Descriere
domeniu (obligatoriu) Domeniu de marcă, inclusiv http sau https
redirecționare rădăcină (opțional) Redirecționare root atunci când cineva îți vizitează domeniul
redirecționare404 (opțional) Redirecționare 404 personalizată
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \
--data-raw '{
    "domeniu": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/domain/add",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "domeniu": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "POST",
    'url': 'https://urlkai.com/api/domain/add',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: JSON.stringify({
    "domeniu": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/domain/add"
sarcina utilă = {
    "domain": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("POST", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{
    "domeniu": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "aplicație/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "ID": 1
} 
ドメインを更新
PUT https://urlkai.com/api/domain/:id/update

Pentru a actualiza un domeniu de marcă, trebuie să trimiteți date valide în JSON printr-o solicitare PUT. Datele trebuie trimise ca corp brut al solicitării dvs., așa cum se arată mai jos. Exemplul de mai jos arată toți parametrii pe care îi puteți trimite, dar nu vi se cere să îi trimiteți pe toți (consultați tabelul pentru mai multe informații).

Parametru Descriere
redirecționare rădăcină (opțional) Redirecționare root atunci când cineva îți vizitează domeniul
redirecționare404 (opțional) Redirecționare 404 personalizată
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "PUT",
    'url': 'https://urlkai.com/api/domain/:id/update',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/domain/:id/update"
sarcina utilă = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("PUT", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "aplicație/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "Domeniul a fost actualizat cu succes."
} 
Ștergeți domeniul
DELETE https://urlkai.com/api/domain/:id/delete

Pentru a șterge un domeniu, trebuie să trimiteți o solicitare de ȘTERGERE.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "ȘTERGE",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "DELETE",
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/domain/:id/delete"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("DELETE", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "Domeniul a fost șters cu succes."
} 

Suprapuneri CTA

Listați suprapunerile CTA
GET https://urlkai.com/api/overlay?limit=2&page=1

Pentru a obține suprapuneri cta prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Descriere
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "GET",
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/overlay?limit=2&page=1"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("GET", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "error": "0",
    "date": {
        "rezultat": 2,
        "perpage": 2,
        "pagina curentă": 1,
        "pagina următoare": 1,
        "maxpage": 1,
        "CTA": [
            {
                "id": 1,
                "type": "mesaj",
                "name": "Produs 1 Promo",
                "data": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "contact",
                "name": "Pagina de contact",
                "data": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Campanii

Listați campaniile
GET https://urlkai.com/api/campaigns?limit=2&page=1

Pentru a obține campaniile prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Descriere
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "GET",
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("GET", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "error": "0",
    "date": {
        "rezultat": 2,
        "perpage": 2,
        "pagina curentă": 1,
        "pagina următoare": 1,
        "maxpage": 1,
        "campanii": [
            {
                "id": 1,
                "name": "Exemplu de campanie",
                "public": fals,
                "rotator": fals,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Campanie Facebook",
                "public": adevărat,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
Create a Campaign
POST https://urlkai.com/api/campaign/add

O campanie poate fi adăugată folosind acest punct final.

Parametru Descriere
nume (opțional) Numele campaniei
melc (opțional) Rotator Slug
public (opțional) Acces
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \
--data-raw '{
    "name": "Campanie nouă",
    "slug": "campanie nouă",
    "public": adevărat
}' 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Campanie nouă",
	    "slug": "campanie nouă",
	    "public": adevărat
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "POST",
    'url': 'https://urlkai.com/api/campaign/add',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: JSON.stringify({
    "name": "Campanie nouă",
    "slug": "campanie nouă",
    "public": adevărat
}),
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/campaign/add"
sarcina utilă = {
    "name": "Campanie nouă",
    "slug": "campanie nouă",
    "public": adevărat
}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("POST", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{
    "name": "Campanie nouă",
    "slug": "campanie nouă",
    "public": adevărat
}", System.Text.Encoding.UTF8, "aplicație/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "id": 3,
    "domain": "Campanie nouă",
    "public": adevărat,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Un link scurt poate fi atribuit unei campanii folosind acest punct final. Punctul final necesită ID-ul campaniei și ID-ul linkului scurt.

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "POST",
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("POST", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "Link adăugat cu succes la campanie."
} 
キャンペーンの更新
PUT https://urlkai.com/api/campaign/:id/update

Pentru a actualiza o campanie, trebuie să trimiteți date valide în JSON printr-o solicitare PUT. Datele trebuie trimise ca corp brut al solicitării dvs., așa cum se arată mai jos. Exemplul de mai jos arată toți parametrii pe care îi puteți trimite, dar nu vi se cere să îi trimiteți pe toți (consultați tabelul pentru mai multe informații).

Parametru Descriere
nume (obligatoriu) Numele campaniei
melc (opțional) Rotator Slug
public (opțional) Acces
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \
--data-raw '{
    "name": "Campanie Twitter",
    "slug": "campanie Twitter",
    "public": adevărat
}' 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Campanie Twitter",
	    "slug": "campanie Twitter",
	    "public": adevărat
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "PUT",
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: JSON.stringify({
    "name": "Campanie Twitter",
    "slug": "campanie Twitter",
    "public": adevărat
}),
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/campaign/:id/update"
sarcina utilă = {
    "name": "Campanie Twitter",
    "slug": "campanie Twitter",
    "public": adevărat
}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("PUT", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{
    "name": "Campanie Twitter",
    "slug": "campanie Twitter",
    "public": adevărat
}", System.Text.Encoding.UTF8, "aplicație/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "id": 3,
    "domain": "Campanie Twitter",
    "public": adevărat,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
Ștergeți campania
DELETE https://urlkai.com/api/campaign/:id/delete

Pentru a șterge o campanie, trebuie să trimiteți o solicitare de ȘTERGERE.

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "ȘTERGE",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "DELETE",
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/campaign/:id/delete"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("DELETE", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "Campania a fost ștearsă cu succes."
} 

Custom Splash

Listați Splash personalizat
GET https://urlkai.com/api/splash?limit=2&page=1

Pentru a obține pagini de pornire personalizate prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Descriere
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "GET",
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/splash?limit=2&page=1"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("GET", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "error": "0",
    "date": {
        "rezultat": 2,
        "perpage": 2,
        "pagina curentă": 1,
        "pagina următoare": 1,
        "maxpage": 1,
        "splash": [
            {
                "id": 1,
                "name": "Produs 1 Promo",
                "data": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Promoția produsului 2",
                "data": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Fişierele

Fișiere de listă
GET https://urlkai.com/api/files?limit=2&page=1

Obțineți toate fișierele. De asemenea, puteți căuta după nume.

Parametru Descriere
nume (opțional) Căutarea unui fișier după nume
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/files?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
import requests
url = "https://urlkai.com/api/files?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/files?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Server response
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/aTQrt",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/BrcfR",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/vKdfs",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
Încărcați un fișier
POST https://urlkai.com/api/files/upload/:filename?name=My+File

Încărcați un fișier trimițând datele binare ca corp al postării. Trebuie să trimiteți numele fișierului, inclusiv extensia, în loc de :filename în url (de exemplu, brandkit.zip). Puteți seta opțiunile trimițând următorii parametri.

Parametru Descriere
nume (opțional) Nume fișier
obicei (opțional) Alias personalizat în loc de alias aleatoriu.
domeniu (opțional) Domeniu personalizat
parolă (opțional) Protecție prin parolă
Expirare (opțional) Expirarea pentru exemplul de descărcare 2021-09-28
descărcări maxime (opțional) Numărul maxim de descărcări
curl --location --request POST 'https://urlkai.com/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'
$curl = curl_init();

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

$response = curl_exec($curl);

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

Pixeli

Lista de pixeli
GET https://urlkai.com/api/pixels?limit=2&page=1

Pentru a obține codurile pixelilor prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Descriere
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "GET",
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/pixels?limit=2&page=1"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("GET", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "error": "0",
    "date": {
        "rezultat": 2,
        "perpage": 2,
        "pagina curentă": 1,
        "pagina următoare": 1,
        "maxpage": 1,
        "pixeli": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM Pixel",
                "tag": "GA-123456789",
                "data": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "twitterpixel",
                "name": "Twitter Pixel",
                "tag": "1234567",
                "data": "2020-11-10 18:10:00"
            }
        ]
    }
} 
Creați un pixel
POST https://urlkai.com/api/pixel/add

Un pixel poate fi creat folosind acest punct final. Trebuie să trimiteți tipul de pixel și eticheta.

Parametru Descriere
tip (obligatoriu) gtmpixel | gapixel | fbpixel | adwordspixel | LinkedInPixel | TwitterPixel | AdrollPixel | Quorapixel | Pinterest | Bing | Snapchat | reddit | TikTok
nume (obligatoriu) Nume personalizat pentru pixel
etichetă (obligatoriu) Eticheta pentru pixel
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "GTM-ul meu",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "gtmpixel",
	    "name": "GTM-ul meu",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "POST",
    'url': 'https://urlkai.com/api/pixel/add',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: JSON.stringify({
    "type": "gtmpixel",
    "name": "GTM-ul meu",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/pixel/add"
sarcina utilă = {
    "type": "gtmpixel",
    "name": "GTM-ul meu",
    "tag": "GTM-ABCDE"
}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("POST", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{
    "type": "gtmpixel",
    "name": "GTM-ul meu",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "aplicație/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "ID": 1
} 
ピクセルを更新する
PUT https://urlkai.com/api/pixel/:id/update

Pentru a actualiza un pixel, trebuie să trimiteți date valide în JSON printr-o solicitare PUT. Datele trebuie trimise ca corp brut al solicitării dvs., așa cum se arată mai jos. Exemplul de mai jos arată toți parametrii pe care îi puteți trimite, dar nu vi se cere să îi trimiteți pe toți (consultați tabelul pentru mai multe informații).

Parametru Descriere
nume (opțional) Nume personalizat pentru pixel
etichetă (obligatoriu) Eticheta pentru pixel
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \
--data-raw '{
    "name": "GTM-ul meu",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "GTM-ul meu",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "PUT",
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: JSON.stringify({
    "name": "GTM-ul meu",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/pixel/:id/update"
sarcina utilă = {
    "name": "GTM-ul meu",
    "tag": "GTM-ABCDE"
}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("PUT", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{
    "name": "GTM-ul meu",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "aplicație/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "Pixel a fost actualizat cu succes."
} 
Ștergeți pixelul
DELETE https://urlkai.com/api/pixel/:id/delete

Pentru a șterge un pixel, trebuie să trimiteți o solicitare de ȘTERGERE.

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "ȘTERGE",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "DELETE",
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/pixel/:id/delete"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("DELETE", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "Pixelul a fost șters cu succes."
} 

QRコード

Listați codurile QR
GET https://urlkai.com/api/qr?limit=2&page=1

Pentru a obține codurile QR prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Descriere
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "GET",
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/qr?limit=2&page=1"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("GET", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "error": "0",
    "date": {
        "rezultat": 2,
        "perpage": 2,
        "pagina curentă": 1,
        "pagina următoare": 1,
        "maxpage": 1,
        "qrs": [
            {
                "id": 2,
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "scanări": 0,
                "name": "Google",
                "data": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/urlkai.com\/qr\/b9edfe",
                "scanări": 5,
                "name": "Google Canada",
                "data": "2020-11-10 18:00:25"
            }
        ]
    }
} 
Obțineți un singur cod QR
GET https://urlkai.com/api/qr/:id

Pentru a obține detalii pentru un singur cod QR prin API, puteți utiliza acest punct final.

curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "GET",
    'url': 'https://urlkai.com/api/qr/:id',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/qr/:id"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("GET", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "detalii": {
        "id": 1,
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "scanări": 5,
        "name": "Google Canada",
        "data": "2020-11-10 18:00:25"
    },
    "date": {
        "clicuri": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Necunoscut": "1"
        },
        "topReferrers": {
            "Direct, e-mail și altele": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "facebook": 0,
            "Twitter": 0,
            "Instagram": 0
        }
    }
} 
Creați un cod QR
POST https://urlkai.com/api/qr/add

Pentru a crea un cod QR, trebuie să trimiteți date valide în JSON printr-o solicitare POST. Datele trebuie trimise ca corp brut al solicitării dvs., așa cum se arată mai jos. Exemplul de mai jos arată toți parametrii pe care îi puteți trimite, dar nu vi se cere să îi trimiteți pe toți (consultați tabelul pentru mai multe informații).

Parametru Descriere
tip text (obligatoriu) | vcard | legătură | E-mail | telefon | SMS | Wi-Fi
date (obligatoriu) Date care trebuie încorporate în codul QR. Datele pot fi șir sau matrice în funcție de tip
fond (opțional) Culoare RGB, de exemplu rgb (255,255,255)
Prim plan (opțional) Culoare RGB, de exemplu rgb(0,0,0)
siglă (opțional) Calea către logo, fie png, fie jpg
nume (opțional) Numele codului QR
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "prim-plan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API cod QR"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/qr/add",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "link",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "prim-plan": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": "API cod QR"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "POST",
    'url': 'https://urlkai.com/api/qr/add',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: JSON.stringify({
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "prim-plan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API cod QR"
}),
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/qr/add"
sarcina utilă = {
    "type": "link",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "prim-plan": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png",
    "name": "API cod QR"
}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("POST", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "prim-plan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API cod QR"
}", System.Text.Encoding.UTF8, "aplicație/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "id": 3,
    "link": "https:\/\/urlkai.com\/qr\/a58f79"
} 
Actualizați codul QR
PUT https://urlkai.com/api/qr/:id/update

Pentru a actualiza un cod QR, trebuie să trimiteți o dată validă în JSON printr-o solicitare PUT. Datele trebuie trimise ca corp brut al solicitării dvs., așa cum se arată mai jos. Exemplul de mai jos arată toți parametrii pe care îi puteți trimite, dar nu vi se cere să îi trimiteți pe toți (consultați tabelul pentru mai multe informații).

Parametru Descriere
date (obligatoriu) Date care trebuie încorporate în codul QR. Datele pot fi șir sau matrice în funcție de tip
fond (opțional) Culoare RGB, de exemplu rgb (255,255,255)
Prim plan (opțional) Culoare RGB, de exemplu rgb(0,0,0)
siglă (opțional) Calea către logo, fie png, fie jpg
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "prim-plan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "link",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "prim-plan": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "PUT",
    'url': 'https://urlkai.com/api/qr/:id/update',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: JSON.stringify({
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "prim-plan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/qr/:id/update"
sarcina utilă = {
    "type": "link",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "prim-plan": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("PUT", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "prim-plan": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "aplicație/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "QR a fost actualizat cu succes."
} 
Ștergeți un cod QR
DELETE https://urlkai.com/api/qr/:id/delete

Pentru a șterge un cod QR, trebuie să trimiteți o solicitare de ȘTERGERE.

curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "ȘTERGE",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "DELETE",
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/qr/:id/delete"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("DELETE", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "Codul QR a fost șters cu succes."
} 

チャンネル一覧

Lista canalelor
GET https://urlkai.com/api/channels?limit=2&page=1

Pentru a obține canalele prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Descriere
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "GET",
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/channels?limit=2&page=1"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("GET", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "error": "0",
    "date": {
        "rezultat": 2,
        "perpage": 2,
        "pagina curentă": 1,
        "pagina următoare": 1,
        "maxpage": 1,
        "canale": [
            {
                "id": 1,
                "name": "Canalul 1",
                "description": "Descrierea canalului 1",
                "color": "#000000",
                "Starred": adevărat
            },
            {
                "id": 2,
                "name": "Canalul 2",
                "description": "Descrierea canalului 2",
                "color": "#FF0000",
                "Starred": fals
            }
        ]
    }
} 
Listați elementele canalului
GET https://urlkai.com/api/channel/:id?limit=1&page=1

Pentru a obține elemente dintr-un anumit canal prin API, puteți utiliza acest punct final. De asemenea, puteți filtra datele (consultați tabelul pentru mai multe informații).

Parametru Descriere
limită (opțional) Rezultat de date pe pagină
pagină (opțional) Solicitare pagină curentă
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "GET",
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("GET", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "error": "0",
    "date": {
        "rezultat": 2,
        "perpage": 2,
        "pagina curentă": 1,
        "pagina următoare": 1,
        "maxpage": 1,
        "articole": [
            {
                "type": "linkuri",
                "id": 1,
                "title": "Exemplul meu de link",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "data": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "Exemplul meu de biografie",
                "preview": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "data": "2022-06-01"
            }
        ]
    }
} 
Create a Channel
POST https://urlkai.com/api/channel/add

Un canal poate fi adăugat folosind acest punct final.

Parametru Descriere
nume (obligatoriu) Numele canalului
descriere (opțional) Descrierea canalului
culoare (opțional) Culoarea insignei canalului (HEX)
Jucat (opțional) Marcați canalul cu o stea sau nu (adevărat sau fals)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \
--data-raw '{
    "name": "Canal nou",
    "description": "noul meu canal",
    "color": "#000000",
    "Starred": adevărat
}' 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Canal nou",
	    "description": "noul meu canal",
	    "color": "#000000",
	    "Starred": adevărat
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "POST",
    'url': 'https://urlkai.com/api/channel/add',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: JSON.stringify({
    "name": "Canal nou",
    "description": "noul meu canal",
    "color": "#000000",
    "Starred": adevărat
}),
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/channel/add"
sarcina utilă = {
    "name": "Canal nou",
    "description": "noul meu canal",
    "color": "#000000",
    "Starred": adevărat
}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("POST", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{
    "name": "Canal nou",
    "description": "noul meu canal",
    "color": "#000000",
    "Starred": adevărat
}", System.Text.Encoding.UTF8, "aplicație/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "id": 3,
    "name": "Canal nou",
    "description": "noul meu canal",
    "color": "#000000",
    "Starred": adevărat
} 
Atribuirea unui articol unui canal
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Un articol poate fi atribuit oricărui canal prin trimiterea unei solicitări cu ID-ul canalului, tipul articolului (link-uri, biografie sau qr) și ID-ul articolului.

Parametru Descriere
:channelid (obligatoriu) ID-ul canalului
:tip (obligatoriu) link-uri sau bio sau qr
:itemid (obligatoriu) ID articol
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "POST",
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("POST", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "Element adăugat cu succes la canal."
} 
Update Channel
PUT https://urlkai.com/api/channel/:id/update

Pentru a actualiza un canal, trebuie să trimiteți date valide în JSON printr-o solicitare PUT. Datele trebuie trimise ca corp brut al solicitării dvs., așa cum se arată mai jos. Exemplul de mai jos arată toți parametrii pe care îi puteți trimite, dar nu vi se cere să îi trimiteți pe toți (consultați tabelul pentru mai multe informații).

Parametru Descriere
nume (opțional) Numele canalului
descriere (opțional) Descrierea canalului
culoare (opțional) Culoarea insignei canalului (HEX)
Jucat (opțional) Marcați canalul cu o stea sau nu (adevărat sau fals)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "canal pentru articole pentru Acme Corp",
    "color": "#FFFFFF",
    "Starred": fals
}' 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Acme Corp",
	    "description": "canal pentru articole pentru Acme Corp",
	    "color": "#FFFFFF",
	    "Starred": fals
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "metodă": "PUT",
    'url': 'https://urlkai.com/api/channel/:id/update',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    corp: JSON.stringify({
    "name": "Acme Corp",
    "description": "canal pentru articole pentru Acme Corp",
    "color": "#FFFFFF",
    "Starred": fals
}),
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/channel/:id/update"
sarcina utilă = {
    "name": "Acme Corp",
    "description": "canal pentru articole pentru Acme Corp",
    "color": "#FFFFFF",
    "Starred": fals
}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("PUT", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{
    "name": "Acme Corp",
    "description": "canal pentru articole pentru Acme Corp",
    "color": "#FFFFFF",
    "Starred": fals
}", System.Text.Encoding.UTF8, "aplicație/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "Canalul a fost actualizat cu succes."
} 
Ștergeți canalul
DELETE https://urlkai.com/api/channel/:id/delete

Pentru a șterge un canal, trebuie să trimiți o solicitare de ȘTERGERE. Toate elementele vor fi de asemenea anulate.

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Autorizare: Purtător YOURAPIKEY' \
--header 'Tip de conținut: aplicație/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrice(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => adevărat,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => adevărat,
    CURLOPT_CUSTOMREQUEST => "ȘTERGE",
    CURLOPT_HTTPHEADER => [
        "Autorizație: Purtător YOURAPIKEY",
        "Tip de conținut: aplicație/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ecou $response; 
var request = require('request');
var options = {
    "method": "DELETE",
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'anteturi': {
        "Autorizație": "Purtătorul YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    dacă (eroare) aruncă o nouă eroare (eroare);
    console.log(răspuns.corp);
}); 
Solicitări de import
url = "https://urlkai.com/api/channel/:id/delete"
sarcină utilă = {}
anteturi = {
    "Autorizație": "Purtătorul YOURAPIKEY",
    'Content-Type': 'application/json'
}
răspuns = requests.request("DELETE", url, headers=headers, json=payload)
print(răspuns.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
cerere. Headers.Add("Autorizare", "Purtător YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
cerere. Conținut = conținut;
var răspuns = așteaptă clientul. SendAsync(cerere);
răspuns. EnsureSuccessStatusCode();
Console.WriteLine(așteaptă răspunsul. Content.ReadAsStringAsync()); 
Server response
{
    "eroare": 0,
    "message": "Canalul a fost șters cu succes."
} 

リンク