Referencia de API para desarrolladores

Empezando

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

Autenticación

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

curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "OBJAVA",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
));

$response = curl_exec($curl); 
var request = require('request');
var možnosti = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/account',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    Body: ''
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/account"
koristni tovor = {}
glave = {
  "Dovoljenje": "Nosilec YOURAPIKEY",
  'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Límite de tarifa

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

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

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

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

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

Campañas

Oglaševalske akcije na seznamu
GET https://urlkai.com/api/campaigns?limit=2&page=1

Če želite oglaševalske akcije pridobiti prek API-ja, lahko uporabite to končno točko. Podatke lahko tudi filtrirate (za več informacij glejte tabelo).

ParámetroDescripción
omejiti (neobvezno) Rezultat podatkov na stran
stran (neobvezno) Trenutna zahteva za stran
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": "0",
    "podatki": {
        "rezultat": 2,
        "perpage": 2,
        "trenutna stran": 1,
        "naslednja stran": 1,
        "maxpage": 1,
        "kampanje": [
            {
                "id": 1,
                "name": "Vzorčna oglaševalska akcija",
                "javno": napačno,
                "rotator": napačno,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domena": "Facebook kampanja",
                "javno": res,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
Crear una campaña
POST https://urlkai.com/api/campaign/add

Oglaševalsko akcijo lahko dodate s to končno točko.

ParámetroDescripción
ime (neobvezno) Ime oglaševalske akcije
Slug (neobvezno) Rotatorski polž
javnost (neobvezno) Dostop
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \
--data-raw '{
    "name": "Nova kampanja",
    "slug": "nova-kampanja",
    "javno": res
}' 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "OBJAVA",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Nova kampanja",
	    "slug": "nova-kampanja",
	    "javno": res
	}',
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/add',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Nova kampanja",
    "slug": "nova-kampanja",
    "javno": res
}),
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/campaign/add"
koristni tovor = {
    "name": "Nova kampanja",
    "slug": "nova-kampanja",
    "javno": res
}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{
    "name": "Nova kampanja",
    "slug": "nova-kampanja",
    "javno": res
}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "id": 3,
    "domain": "Nova oglaševalska akcija",
    "javno": res,
    "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

S to končno točko lahko oglaševalski akciji dodelite kratko povezavo. Za končno točko potrebujete ID oglaševalske akcije in ID kratke povezave.

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "OBJAVA",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "Povezava je bila uspešno dodana v oglaševalsko akcijo."
} 
Actualizar campaña
PUT https://urlkai.com/api/campaign/:id/update

Če želite posodobiti oglaševalsko akcijo, morate poslati veljavne podatke v JSON prek zahteve PUT. Podatki morajo biti poslani kot neobdelano telo vaše zahteve, kot je prikazano spodaj. Spodnji primer prikazuje vse parametre, ki jih lahko pošljete, vendar vam ni treba poslati vseh (za več informacij glejte tabelo).

ParámetroDescripción
ime (obvezno) Ime oglaševalske akcije
Slug (neobvezno) Rotatorski polž
javnost (neobvezno) Dostop
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \
--data-raw '{
    "name": "Kampanja na Twitterju",
    "slug": "twitter-kampanja",
    "javno": res
}' 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Kampanja na Twitterju",
	    "slug": "twitter-kampanja",
	    "javno": res
	}',
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    "metoda": "PUT",
    'URL': 'https://urlkai.com/api/campaign/:id/update',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Kampanja na Twitterju",
    "slug": "twitter-kampanja",
    "javno": res
}),
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/campaign/:id/update"
koristni tovor = {
    "name": "Kampanja na Twitterju",
    "slug": "twitter-kampanja",
    "javno": res
}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{
    "name": "Kampanja na Twitterju",
    "slug": "twitter-kampanja",
    "javno": res
}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "id": 3,
    "domain": "Twitter kampanja",
    "javno": res,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
Brisanje oglaševalske akcije
DELETE https://urlkai.com/api/campaign/:id/delete

Če želite izbrisati oglaševalsko akcijo, morate poslati zahtevo za izbris.

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "IZBRIŠI",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'DELETE',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/campaign/:id/delete"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "Oglaševalska akcija je bila uspešno izbrisana."
} 

Canales

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

Če želite pridobiti kanale prek API-ja, lahko uporabite to končno točko. Podatke lahko tudi filtrirate (za več informacij glejte tabelo).

ParámetroDescripción
omejiti (neobvezno) Rezultat podatkov na stran
stran (neobvezno) Trenutna zahteva za stran
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'GET',
    'URL': 'https://urlkai.com/api/channels?limit=2&page=1',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/channels?limit=2&page=1"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": "0",
    "podatki": {
        "rezultat": 2,
        "perpage": 2,
        "trenutna stran": 1,
        "naslednja stran": 1,
        "maxpage": 1,
        "kanali": [
            {
                "id": 1,
                "name": "Kanal 1",
                "description": "Opis kanala 1",
                "color": "#000000",
                "Zvezda": Resnično
            },
            {
                "id": 2,
                "name": "Kanal 2",
                "description": "Opis kanala 2",
                "color": "#FF0000",
                "Zvezda": Napačno
            }
        ]
    }
} 
Seznam elementov kanala
GET https://urlkai.com/api/channel/:id?limit=1&page=1

Če želite pridobiti elemente v izbranih kanalih prek API-ja, lahko uporabite to končno točko. Podatke lahko tudi filtrirate (za več informacij glejte tabelo).

ParámetroDescripción
omejiti (neobvezno) Rezultat podatkov na stran
stran (neobvezno) Trenutna zahteva za stran
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": "0",
    "podatki": {
        "rezultat": 2,
        "perpage": 2,
        "trenutna stran": 1,
        "naslednja stran": 1,
        "maxpage": 1,
        "predmeti": [
            {
                "type": "povezave",
                "id": 1,
                "title": "Moja vzorčna povezava",
                "predogled": "https:\/\/google.com",
                "povezava": "https:\/\/urlkai.com\/google",
                "datum": "2022-05-12"
            },
            {
                "vrsta": "bio",
                "id": 1,
                "title": "Moj vzorčni življenjepis",
                "predogled": "https:\/\/urlkai.com\/mybio",
                "povezava": "https:\/\/urlkai.com\/mybio",
                "datum": "2022-06-01"
            }
        ]
    }
} 
Crear un canal
POST https://urlkai.com/api/channel/add

S to končno točko lahko dodate kanal.

ParámetroDescripción
ime (obvezno) Ime kanala
opis (neobvezno) Opis kanala
barva (neobvezno) Barva značke kanala (HEX)
Zvezdico (neobvezno) Kanal označite z zvezdico ali ne (res ali napačno)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \
--data-raw '{
    "name": "Novi kanal",
    "description": "moj novi kanal",
    "color": "#000000",
    "Zvezda": Resnično
}' 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "OBJAVA",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Novi kanal",
	    "description": "moj novi kanal",
	    "color": "#000000",
	    "Zvezda": Resnično
	}',
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'POST',
    'URL': 'https://urlkai.com/api/channel/add',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Novi kanal",
    "description": "moj novi kanal",
    "color": "#000000",
    "Zvezda": Resnično
}),
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/channel/add"
koristni tovor = {
    "name": "Novi kanal",
    "description": "moj novi kanal",
    "color": "#000000",
    "Zvezda": Resnično
}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{
    "name": "Novi kanal",
    "description": "moj novi kanal",
    "color": "#000000",
    "Zvezda": Resnično
}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "id": 3,
    "name": "Novi kanal",
    "description": "moj novi kanal",
    "color": "#000000",
    "Zvezda": Resnično
} 
Dodeljevanje elementa kanalu
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Element lahko dodelite kateremu koli kanalu tako, da pošljete zahtevo z ID-jem kanala, vrsto elementa (povezave, biografija ali qr) in ID-jem elementa.

ParámetroDescripción
:channelid (obvezno) ID kanala
:vrsta (obvezne) povezave ali biografija ali QR
:itemid (obvezno) ID izdelka
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "OBJAVA",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "Element je bil uspešno dodan v kanal."
} 
Actualizar canal
PUT https://urlkai.com/api/channel/:id/update

Če želite posodobiti kanal, morate poslati veljavne podatke v JSON prek zahteve PUT. Podatki morajo biti poslani kot neobdelano telo vaše zahteve, kot je prikazano spodaj. Spodnji primer prikazuje vse parametre, ki jih lahko pošljete, vendar vam ni treba poslati vseh (za več informacij glejte tabelo).

ParámetroDescripción
ime (neobvezno) Ime kanala
opis (neobvezno) Opis kanala
barva (neobvezno) Barva značke kanala (HEX)
Zvezdico (neobvezno) Kanal označite z zvezdico ali ne (res ali napačno)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "kanal za izdelke za Acme Corp",
    "color": "#FFFFFF",
    "Zvezda": Napačno
}' 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Acme Corp",
	    "description": "kanal za izdelke za Acme Corp",
	    "color": "#FFFFFF",
	    "Zvezda": Napačno
	}',
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    "metoda": "PUT",
    'URL': 'https://urlkai.com/api/channel/:id/update',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Acme Corp",
    "description": "kanal za izdelke za Acme Corp",
    "color": "#FFFFFF",
    "Zvezda": Napačno
}),
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/channel/:id/update"
koristni tovor = {
    "name": "Acme Corp",
    "description": "kanal za izdelke za Acme Corp",
    "color": "#FFFFFF",
    "Zvezda": Napačno
}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{
    "name": "Acme Corp",
    "description": "kanal za izdelke za Acme Corp",
    "color": "#FFFFFF",
    "Zvezda": Napačno
}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "Kanal je bil uspešno posodobljen."
} 
Izbriši kanal
DELETE https://urlkai.com/api/channel/:id/delete

Če želite izbrisati kanal, morate poslati zahtevo za izbris. Tudi vsi predmeti bodo nedodeljeni.

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "IZBRIŠI",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'DELETE',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/channel/:id/delete"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "Kanal je bil uspešno izbrisan."
} 

Cuenta

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

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

curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/account',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/account"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "podatki": {
        "id": 1,
        "e-pošta": " [e-pošta zaščitena] ",
        "uporabniško ime": "vzorčni uporabnik",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "za",
        "poteče": "2022-11-15 15:00:00",
        "registriran": "2020-11-10 18:01:43"
    }
} 
Actualizar cuenta
PUT https://urlkai.com/api/account/update

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

curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \
--data-raw '{
    "e-pošta": " [e-pošta zaščitena] ",
    "geslo": "novo geslo"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "e-pošta": " [e-pošta zaščitena] ",
	    "geslo": "novo geslo"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    "metoda": "PUT",
    'url': 'https://urlkai.com/api/account/update',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "e-pošta": " [e-pošta zaščitena] ",
    "geslo": "novo geslo"
}),
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/account/update"
koristni tovor = {
    "e-pošta": " [e-pošta zaščitena] ",
    "geslo": "novo geslo"
}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{
    "e-pošta": " [e-pošta zaščitena] ",
    "geslo": "novo geslo"
}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "Račun je bil uspešno posodobljen."
} 

Códigos QR

Navedite QR kode
GET https://urlkai.com/api/qr?limit=2&page=1

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

ParámetroDescripción
omejiti (neobvezno) Rezultat podatkov na stran
stran (neobvezno) Trenutna zahteva za stran
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'GET',
    'URL': 'https://urlkai.com/api/qr?limit=2&page=1',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/qr?limit=2&page=1"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": "0",
    "podatki": {
        "rezultat": 2,
        "perpage": 2,
        "trenutna stran": 1,
        "naslednja stran": 1,
        "maxpage": 1,
        "qrs": [
            {
                "id": 2,
                "povezava": "https:\/\/urlkai.com\/qr\/a2d5e",
                "skeniranje": 0,
                "ime": "Google",
                "datum": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "povezava": "https:\/\/urlkai.com\/qr\/b9edfe",
                "skeniranje": 5,
                "name": "Google Kanada",
                "datum": "2020-11-10 18:00:25"
            }
        ]
    }
} 
Obtenga un solo código QR
GET https://urlkai.com/api/qr/:id

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

curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'GET',
    'URL': 'https://urlkai.com/api/qr/:id',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/qr/:id"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "podrobnosti": {
        "id": 1,
        "povezava": "https:\/\/urlkai.com\/qr\/b9edfe",
        "skeniranje": 5,
        "name": "Google Kanada",
        "datum": "2020-11-10 18:00:25"
    },
    "podatki": {
        "kliki": 1,
        »uniqueClicks«: 1,
        "topCountries": {
            »Neznano«: »1«
        },
        "topReferrers": {
            »Neposredno, e-pošta in drugo«: »1«
        },
        "topBrowsers": {
            »Chrome«: »1«
        },
        "topOs": {
            »Windows 10«: »1«
        },
        "socialCount": {
            "Facebook": 0,
            "Twitter": 0,
            "Instagram": 0
        }
    }
} 
Crear un código QR
POST https://urlkai.com/api/qr/add

Če želite ustvariti QR kodo, morate poslati veljavne podatke v JSON prek zahteve POST. Podatki morajo biti poslani kot neobdelano telo vaše zahteve, kot je prikazano spodaj. Spodnji primer prikazuje vse parametre, ki jih lahko pošljete, vendar vam ni treba poslati vseh (za več informacij glejte tabelo).

ParámetroDescripción
vrsta (obvezno) besedilo | vcard | povezava | E-pošta | Telefonska številka | SMS | Brezžični internet
podatki (obvezno) Podatki, ki jih je treba vdelati v kodo QR. Podatki so lahko niz ali matrika, odvisno od vrste
ozadje (neobvezno) Barva RGB, npr. rgb(255,255,255)
Ospredju (neobvezno) Barva RGB, npr. rgb(0,0,0)
logotip (neobvezno) Pot do logotipa PNG ali JPG
ime (neobvezno) Ime QR kode
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \
--data-raw '{
    "type": "povezava",
    "data": "https:\/\/google.com",
    "ozadje": "rgb(255,255,255)",
    "v ospredju": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API QR kode"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/qr/add",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "OBJAVA",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "povezava",
	    "data": "https:\/\/google.com",
	    "ozadje": "rgb(255,255,255)",
	    "v ospredju": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": "API QR kode"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/qr/add',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "type": "povezava",
    "data": "https:\/\/google.com",
    "ozadje": "rgb(255,255,255)",
    "v ospredju": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API QR kode"
}),
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/qr/add"
koristni tovor = {
    "type": "povezava",
    "data": "https://google.com",
    "ozadje": "rgb(255,255,255)",
    "v ospredju": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png",
    "name": "API QR kode"
}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{
    "type": "povezava",
    "data": "https:\/\/google.com",
    "ozadje": "rgb(255,255,255)",
    "v ospredju": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API QR kode"
}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "id": 3,
    "povezava": "https:\/\/urlkai.com\/qr\/a58f79"
} 
Posodobitev QR kode
PUT https://urlkai.com/api/qr/:id/update

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

ParámetroDescripción
podatki (obvezno) Podatki, ki jih je treba vdelati v kodo QR. Podatki so lahko niz ali matrika, odvisno od vrste
ozadje (neobvezno) Barva RGB, npr. rgb(255,255,255)
Ospredju (neobvezno) Barva RGB, npr. rgb(0,0,0)
logotip (neobvezno) Pot do logotipa PNG ali JPG
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \
--data-raw '{
    "type": "povezava",
    "data": "https:\/\/google.com",
    "ozadje": "rgb(255,255,255)",
    "v ospredju": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "povezava",
	    "data": "https:\/\/google.com",
	    "ozadje": "rgb(255,255,255)",
	    "v ospredju": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    "metoda": "PUT",
    'url': 'https://urlkai.com/api/qr/:id/update',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "type": "povezava",
    "data": "https:\/\/google.com",
    "ozadje": "rgb(255,255,255)",
    "v ospredju": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/qr/:id/update"
koristni tovor = {
    "type": "povezava",
    "data": "https://google.com",
    "ozadje": "rgb(255,255,255)",
    "v ospredju": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{
    "type": "povezava",
    "data": "https:\/\/google.com",
    "ozadje": "rgb(255,255,255)",
    "v ospredju": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "QR je bil uspešno posodobljen."
} 
Eliminar un código QR
DELETE https://urlkai.com/api/qr/:id/delete

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

curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "IZBRIŠI",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'DELETE',
    'URL': 'https://urlkai.com/api/qr/:id/delete',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/qr/:id/delete"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "QR koda je bila uspešno izbrisana."
} 

Dominios de marca

Navedite domene z blagovno znamko
GET https://urlkai.com/api/domains?limit=2&page=1

Če želite pridobiti domene z blagovno znamko prek API-ja, lahko uporabite to končno točko. Podatke lahko tudi filtrirate (za več informacij glejte tabelo).

ParámetroDescripción
omejiti (neobvezno) Rezultat podatkov na stran
stran (neobvezno) Trenutna zahteva za stran
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/domains?limit=2&page=1"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": "0",
    "podatki": {
        "rezultat": 2,
        "perpage": 2,
        "trenutna stran": 1,
        "naslednja stran": 1,
        "maxpage": 1,
        "domene": [
            {
                "id": 1,
                "domena": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "id": 2,
                "domena": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
} 
Ustvarjanje domene z blagovno znamko
POST https://urlkai.com/api/domain/add

Domeno lahko dodate s to končno točko. Prepričajte se, da je domena pravilno usmerjena na naš strežnik.

ParámetroDescripción
domena (obvezno) Domena z blagovno znamko, vključno s http ali https
Redirectroot (neobvezno) Korenska preusmeritev, ko nekdo obišče vašo domeno
preusmeritev404 (neobvezno) Preusmeritev po meri 404
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \
--data-raw '{
    "domena": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/domain/add",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "OBJAVA",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "domena": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/domain/add',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "domena": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/domain/add"
koristni tovor = {
    "domena": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{
    "domena": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "id": 1
} 
Actualizar dominio
PUT https://urlkai.com/api/domain/:id/update

Če želite posodobiti domeno z blagovno znamko, morate poslati veljavne podatke v JSON prek zahteve PUT. Podatki morajo biti poslani kot neobdelano telo vaše zahteve, kot je prikazano spodaj. Spodnji primer prikazuje vse parametre, ki jih lahko pošljete, vendar vam ni treba poslati vseh (za več informacij glejte tabelo).

ParámetroDescripción
Redirectroot (neobvezno) Korenska preusmeritev, ko nekdo obišče vašo domeno
preusmeritev404 (neobvezno) Preusmeritev po meri 404
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    "metoda": "PUT",
    'URL': 'https://urlkai.com/api/domain/:id/update',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/domain/:id/update"
koristni tovor = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "Domena je bila uspešno posodobljena."
} 
Izbriši domeno
DELETE https://urlkai.com/api/domain/:id/delete

Če želite izbrisati domeno, morate poslati zahtevo DELETE.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "IZBRIŠI",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'DELETE',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/domain/:id/delete"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "Domena je bila uspešno izbrisana."
} 

Enlaces


Datoteke

Seznam datotek
GET https://urlkai.com/api/files?limit=2&page=1

Pridobite vse datoteke. Iščete lahko tudi po imenu.

ParámetroDescripción
ime (neobvezno) Iskanje datoteke po imenu
omejiti (neobvezno) Rezultat podatkov na stran
stran (neobvezno) Trenutna zahteva za stran
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
$curl = curl_init();

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

$response = curl_exec($curl);

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

Naložite datoteko tako, da pošljete binarne podatke kot telo objave. Ime datoteke morate poslati z pripono namesto :filename v url-ju (npr. brandkit.zip). Možnosti lahko nastavite tako, da pošljete naslednje parametre.

ParámetroDescripción
ime (neobvezno) Ime datoteke
običaj (neobvezno) Vzdevek po meri namesto naključnega vzdevka.
domena (neobvezno) Domena po meri
geslo (neobvezno) Zaščita z geslom
Izteka (neobvezno) Potek primera prenosa 2021-09-28
največje število prenosov (neobvezno) Največje število prenosov
curl --location --request POST 'https://urlkai.com/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'
$curl = curl_init();

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

$response = curl_exec($curl);

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

Personalizar página de bienvenida

Seznam Custom Splash
GET https://urlkai.com/api/splash?limit=2&page=1

Če želite pridobiti pozdravne strani po meri prek API-ja, lahko uporabite to končno točko. Podatke lahko tudi filtrirate (za več informacij glejte tabelo).

ParámetroDescripción
omejiti (neobvezno) Rezultat podatkov na stran
stran (neobvezno) Trenutna zahteva za stran
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/splash?limit=2&page=1"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": "0",
    "podatki": {
        "rezultat": 2,
        "perpage": 2,
        "trenutna stran": 1,
        "naslednja stran": 1,
        "maxpage": 1,
        "splash": [
            {
                "id": 1,
                "name": "Promocijski izdelek 1",
                "datum": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Promocijski izdelek 2",
                "datum": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Slikovnih pik

Seznam slikovnih pik
GET https://urlkai.com/api/pixels?limit=2&page=1

Če želite pridobiti kode slikovnih pik prek API-ja, lahko uporabite to končno točko. Podatke lahko tudi filtrirate (za več informacij glejte tabelo).

ParámetroDescripción
omejiti (neobvezno) Rezultat podatkov na stran
stran (neobvezno) Trenutna zahteva za stran
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/pixels?limit=2&page=1"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": "0",
    "podatki": {
        "rezultat": 2,
        "perpage": 2,
        "trenutna stran": 1,
        "naslednja stran": 1,
        "maxpage": 1,
        "slikovne pike": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM Pixel",
                "tag": "GA-123456789",
                "datum": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "twitterpixel",
                "name": "Twitter Pixel",
                "tag": "1234567",
                "datum": "2020-11-10 18:10:00"
            }
        ]
    }
} 
Ustvarjanje slikovne pike
POST https://urlkai.com/api/pixel/add

S to končno točko lahko ustvarite slikovno piko. Poslati morate vrsto slikovnih pik in oznako.

ParámetroDescripción
vrsta (obvezno) GTMPIXEL | Gapixel | fbpixel | AdwordsPixel | Povezava Inpixel | Twitterpixel | AdrollPixel | Quorapixel | Pinterest | Bing | Snapchat | Reddit | TikTok
ime (obvezno) Ime po meri za slikovno piko
Tag (obvezno) Oznaka za slikovno piko
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "Moj GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "OBJAVA",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "gtmpixel",
	    "name": "Moj GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/pixel/add',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "type": "gtmpixel",
    "name": "Moj GTM",
    "tag": "GTM-ABCDE"
}),
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/pixel/add"
koristni tovor = {
    "type": "gtmpixel",
    "name": "Moj GTM",
    "tag": "GTM-ABCDE"
}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{
    "type": "gtmpixel",
    "name": "Moj GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "id": 1
} 
Actualizar píxel
PUT https://urlkai.com/api/pixel/:id/update

Če želite posodobiti slikovno piko, morate poslati veljavne podatke v JSON prek zahteve PUT. Podatki morajo biti poslani kot neobdelano telo vaše zahteve, kot je prikazano spodaj. Spodnji primer prikazuje vse parametre, ki jih lahko pošljete, vendar vam ni treba poslati vseh (za več informacij glejte tabelo).

ParámetroDescripción
ime (neobvezno) Ime po meri za slikovno piko
Tag (obvezno) Oznaka za slikovno piko
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \
--data-raw '{
    "name": "Moj GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Moj GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    "metoda": "PUT",
    'URL': 'https://urlkai.com/api/pixel/:id/update',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    "name": "Moj GTM",
    "tag": "GTM-ABCDE"
}),
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/pixel/:id/update"
koristni tovor = {
    "name": "Moj GTM",
    "tag": "GTM-ABCDE"
}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{
    "name": "Moj GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "Pixel je bil uspešno posodobljen."
} 
Izbriši slikovno piko
DELETE https://urlkai.com/api/pixel/:id/delete

Če želite izbrisati slikovno piko, morate poslati zahtevo za DELETE.

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "IZBRIŠI",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'DELETE',
    'URL': 'https://urlkai.com/api/pixel/:id/delete',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/pixel/:id/delete"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": 0,
    "message": "Pixel je bil uspešno izbrisan."
} 

Superposiciones de CTA

Seznam prekrivnih plasti CTA
GET https://urlkai.com/api/overlay?limit=2&page=1

Če želite pridobiti prekrivne elemente cta prek API-ja, lahko uporabite to končno točko. Podatke lahko tudi filtrirate (za več informacij glejte tabelo).

ParámetroDescripción
omejiti (neobvezno) Rezultat podatkov na stran
stran (neobvezno) Trenutna zahteva za stran
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Pooblastilo: Nosilec YOURAPIKEY' \
--header 'Vrsta vsebine: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matrika(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => resnično,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => resnično,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Pooblastilo: Nosilec YOURAPIKEY",
        "Vrsta vsebine: aplikacija/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
odmev $response; 
var request = require('request');
var možnosti = {
    'method': 'GET',
    'URL': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'glave': {
        "Dovoljenje": "Nosilec YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(možnosti, funkcija (napaka, odgovor) {
    če (napaka) vrže novo napako (napako);
    console.log(response.body);
}); 
Zahteve za uvoz
url = "https://urlkai.com/api/overlay?limit=2&page=1"
koristni tovor = {}
glave = {
    "Dovoljenje": "Nosilec YOURAPIKEY",
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(odgovor.besedilo) 
var odjemalec = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
prositi. Headers.Add("Avtorizacija", "Nosilec YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
prositi. Vsebina = vsebina;
var response = počakajte na odjemalca. SendAsync(zahteva);
odziv. EnsureSuccessStatusCode();
Console.WriteLine(čakajte na odgovor. Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    "napaka": "0",
    "podatki": {
        "rezultat": 2,
        "perpage": 2,
        "trenutna stran": 1,
        "naslednja stran": 1,
        "maxpage": 1,
        "cta": [
            {
                "id": 1,
                "type": "sporočilo",
                "name": "Promocijski izdelek 1",
                "datum": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "kontakt",
                "name": "Kontaktna stran",
                "datum": "2020-11-10 18:10:00"
            }
        ]
    }
}