API-referencia fejlesztőknek

Kezdetekhez

A rendszer által feldolgozandó kérésekhez API-kulcs szükséges. A felhasználó regisztrációja után a rendszer automatikusan létrehoz egy API-kulcsot a felhasználó számára. Az API-kulcsot minden kéréssel el kell küldeni (lásd az alábbi teljes példát). Ha az API-kulcsot nem küldi el vagy lejárt, hiba történik. Ügyeljen arra, hogy az API-kulcsot titokban tartsa a visszaélések elkerülése érdekében.

Hitelesítés

Az API-rendszerrel való hitelesítéshez minden kéréshez el kell küldenie az API-kulcsot engedélyezési jogkivonatként. Az alábbi mintakódot láthatja.

curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
));

$response = curl_exec($curl); 
var kérés = require('kérés');
var opciók = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/account',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    test: ''
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/account"
hasznos adat = {}
fejlécek = {
  "Meghatalmazás": "Hordozó YOURAPIKEY",
  'Content-Type': 'application/json'
}
válasz = requests.request("GET", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Sebességkorlát

API-nk rendelkezik egy sebességkorlátozóval, amely megvédi a kérések megugrását a stabilitás maximalizálása érdekében. A sebességkorlátozónk jelenleg 30 kérésre korlátozódik 1 percenként. Felhívjuk figyelmét, hogy az ár az előfizetett csomagtól függően változhat.

A válasz mellett több fejlécet is küldünk, amelyek megvizsgálhatók a kéréssel kapcsolatos különféle információk meghatározásához.

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Válaszok kezelése

Alapértelmezés szerint minden API-válasz JSON formátumban lesz visszaadva. Ahhoz, hogy ezt használható adatokká alakítsuk, a nyelvnek megfelelően a megfelelő függvényt kell használni. A PHP-ben a json_decode() függvény használható az adatok objektummá (alapértelmezett) vagy tömbdé alakítására (a második paramétert true értékre állítva). Nagyon fontos ellenőrizni a hibakulcsot, mivel ez információt nyújt arról, hogy hiba történt-e vagy sem. A fejléckódot is ellenőrizheti.

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

Számla

Szerezzen fiókot
GET https://urlkai.com/api/account

A fiókkal kapcsolatos információk lekéréséhez küldjön egy kérést erre a végpontra, és az visszaadja a fiók adatait.

curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/account',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/account"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("GET", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "data": {
        "id": 1,
        "e-mail": " [e-mail védett] ",
        "username": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "lejár": "2022-11-15 15:00:00",
        "regisztrált": "2020-11-10 18:01:43"
    }
} 
Fiók frissítése
PUT https://urlkai.com/api/account/update

A fiók adatainak frissítéséhez kérést küldhet ennek a végpontnak, és az frissíti a fiók adatait.

curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \
--data-raw '{
    "e-mail": " [e-mail védett] ",
    "password": "newpassword"
}' 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "e-mail": " [e-mail védett] ",
	    "password": "newpassword"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/account/update',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    törzs: JSON.stringify({
    "e-mail": " [e-mail védett] ",
    "password": "newpassword"
}),
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/account/update"
hasznos adat = {
    "e-mail": " [e-mail védett] ",
    "password": "newpassword"
}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("PUT", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var tartalom = new StringContent("{
    "e-mail": " [e-mail védett] ",
    "password": "newpassword"
}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "A fiók frissítése sikeresen megtörtént."
} 

Márkás domainek

Márkás domainek listázása
GET https://urlkai.com/api/domains?limit=2&page=1

A márkás tartományok API-n keresztüli lekéréséhez használhatja ezt a végpontot. Az adatokat szűrheti is (további információt a táblázatban talál).

Paraméter Leírás
korlát (opcionális) Oldalankénti adateredmény
oldal (opcionális) Aktuális oldal kérése
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/domains?limit=2&page=1"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("GET", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "error": "0",
    "data": {
        "eredmény": 2,
        "oldalanként": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "domains": [
            {
                "id": 1,
                "domain": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "id": 2,
                "domain": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
} 
Márkás domain létrehozása
POST https://urlkai.com/api/domain/add

Ezzel a végponttal tartomány is hozzáadható. Kérjük, győződjön meg arról, hogy a domain helyesen mutat a szerverünkre.

Paraméter Leírás
tartomány (kötelező) Márkás domain, beleértve a http-t vagy a https-t
átirányítási gyökér (opcionális) Gyökérátirányítás, amikor valaki felkeresi a domainjét
átirányítás404 (opcionális) Egyéni 404-es átirányítás
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \
--data-raw '{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/domain/add",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "domain": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/domain/add',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    törzs: JSON.stringify({
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/domain/add"
hasznos adat = {
    "domain": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("POST", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var kérés = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var tartalom = new StringContent("{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "id": 1
} 
Tartomány frissítése
PUT https://urlkai.com/api/domain/:id/update

Márkás tartomány frissítéséhez érvényes adatokat kell küldenie JSON-ban egy PUT-kérésen keresztül. Az adatokat a kérelem nyers törzseként kell elküldeni az alábbiak szerint. Az alábbi példa az összes elküldhető paramétert mutatja, de nem kell az összeset elküldenie (további információt a táblázatban talál).

Paraméter Leírás
átirányítási gyökér (opcionális) Gyökérátirányítás, amikor valaki felkeresi a domainjét
átirányítás404 (opcionális) Egyéni 404-es átirányítás
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/domain/:id/update',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    törzs: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/domain/:id/update"
hasznos adat = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("PUT", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var kérés = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var tartalom = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "A tartomány frissítése sikeresen megtörtént."
} 
Domain törlése
DELETE https://urlkai.com/api/domain/:id/delete

Domain törléséhez TÖRLÉS kérelmet kell küldenie.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "TÖRLÉS",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'TÖRLÉS',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/domain/:id/delete"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("DELETE", url, headers=headers, json=hasznos tartalom)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var kérés = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "A tartomány törlése sikeresen megtörtént."
} 

CTA fedvények

CTA-átfedések listázása
GET https://urlkai.com/api/overlay?limit=2&page=1

Ha az API-n keresztül szeretne cta-átfedéseket kapni, használhatja ezt a végpontot. Az adatokat szűrheti is (további információt a táblázatban talál).

Paraméter Leírás
korlát (opcionális) Oldalankénti adateredmény
oldal (opcionális) Aktuális oldal kérése
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/overlay?limit=2&page=1"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("GET", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "error": "0",
    "data": {
        "eredmény": 2,
        "oldalanként": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "cta": [
            {
                "id": 1,
                "type": "üzenet",
                "name": "1. termék promóció",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "kapcsolat",
                "name": "Kapcsolatfelvételi oldal",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Kampányok

Kampányok listázása
GET https://urlkai.com/api/campaigns?limit=2&page=1

Ha kampányait az API-n keresztül szeretné letölteni, használhatja ezt a végpontot. Az adatokat szűrheti is (további információt a táblázatban talál).

Paraméter Leírás
korlát (opcionális) Oldalankénti adateredmény
oldal (opcionális) Aktuális oldal kérése
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("GET", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "error": "0",
    "data": {
        "eredmény": 2,
        "oldalanként": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "kampányok": [
            {
                "id": 1,
                "name": "Minta kampány",
                "nyilvános": hamis,
                "rotator": hamis,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Facebook kampány",
                "nyilvános": igaz,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
Kampány létrehozása
POST https://urlkai.com/api/campaign/add

Ezzel a végponttal kampány adható hozzá.

Paraméter Leírás
név (opcionális) Kampány neve
meztelen csiga (opcionális) Rotátor csiga
nyilvános (opcionális) Hozzáférés
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \
--data-raw '{
    "name": "Új kampány",
    "slug": "új-kampány",
    "nyilvános": igaz
}' 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Új kampány",
	    "slug": "új-kampány",
	    "nyilvános": igaz
	}',
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/add',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    törzs: JSON.stringify({
    "name": "Új kampány",
    "slug": "új-kampány",
    "nyilvános": igaz
}),
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/campaign/add"
hasznos adat = {
    "name": "Új kampány",
    "slug": "új-kampány",
    "nyilvános": igaz
}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("POST", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var tartalom = new StringContent("{
    "name": "Új kampány",
    "slug": "új-kampány",
    "nyilvános": igaz
}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "id": 3,
    "domain": "Új kampány",
    "nyilvános": igaz,
    "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

Ezzel a végponttal rövid hivatkozás rendelhető hozzá egy kampányhoz. A végponthoz szükség van a kampányazonosítóra és a rövid hivatkozás azonosítójára.

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("POST", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var kérés = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "A link sikeresen hozzáadva a kampányhoz."
} 
Kampány frissítése
PUT https://urlkai.com/api/campaign/:id/update

A kampány frissítéséhez érvényes adatokat kell küldenie JSON-ban egy PUT-kérésen keresztül. Az adatokat a kérelem nyers törzseként kell elküldeni az alábbiak szerint. Az alábbi példa az összes elküldhető paramétert mutatja, de nem kell az összeset elküldenie (további információt a táblázatban talál).

Paraméter Leírás
név (kötelező) Kampány neve
meztelen csiga (opcionális) Rotátor csiga
nyilvános (opcionális) Hozzáférés
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \
--data-raw '{
    "name": "Twitter kampány",
    "Slug": "Twitter-kampány",
    "nyilvános": igaz
}' 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Twitter kampány",
	    "Slug": "Twitter-kampány",
	    "nyilvános": igaz
	}',
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    törzs: JSON.stringify({
    "name": "Twitter kampány",
    "Slug": "Twitter-kampány",
    "nyilvános": igaz
}),
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/campaign/:id/update"
hasznos adat = {
    "name": "Twitter kampány",
    "Slug": "Twitter-kampány",
    "nyilvános": igaz
}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("PUT", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var tartalom = new StringContent("{
    "name": "Twitter kampány",
    "Slug": "Twitter-kampány",
    "nyilvános": igaz
}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "id": 3,
    "domain": "Twitter-kampány",
    "nyilvános": igaz,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
Kampány törlése
DELETE https://urlkai.com/api/campaign/:id/delete

Kampány törléséhez TÖRLÉS kérelmet kell küldenie.

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "TÖRLÉS",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'TÖRLÉS',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/campaign/:id/delete"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("DELETE", url, headers=headers, json=hasznos tartalom)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "A kampány törlése sikeresen megtörtént."
} 

Csatornák

Csatornák listázása
GET https://urlkai.com/api/channels?limit=2&page=1

Ha a csatornákat az API-n keresztül szeretné lekérni, használhatja ezt a végpontot. Az adatokat szűrheti is (további információt a táblázatban talál).

Paraméter Leírás
korlát (opcionális) Oldalankénti adateredmény
oldal (opcionális) Aktuális oldal kérése
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/channels?limit=2&page=1"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("GET", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var kérés = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "error": "0",
    "data": {
        "eredmény": 2,
        "oldalanként": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "csatornák": [
            {
                "id": 1,
                "name": "1. csatorna",
                "description": "Az 1. csatorna leírása",
                "color": "#000000",
                "csillagos": igaz
            },
            {
                "id": 2,
                "name": "2. csatorna",
                "description": "A 2. csatorna leírása",
                "color": "#FF0000",
                "csillagos": hamis
            }
        ]
    }
} 
Csatornaelemek listázása
GET https://urlkai.com/api/channel/:id?limit=1&page=1

Ha az API-n keresztül szeretne elemeket lekérni egy kiválasztott csatornában, használhatja ezt a végpontot. Az adatokat szűrheti is (további információt a táblázatban talál).

Paraméter Leírás
korlát (opcionális) Oldalankénti adateredmény
oldal (opcionális) Aktuális oldal kérése
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("GET", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "error": "0",
    "data": {
        "eredmény": 2,
        "oldalanként": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "items": [
            {
                "type": "linkek",
                "id": 1,
                "title": "Saját minta link",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "date": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "Saját minta életrajzom",
                "preview": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "date": "2022-06-01"
            }
        ]
    }
} 
Csatorna létrehozása
POST https://urlkai.com/api/channel/add

Ezzel a végponttal csatorna adható hozzá.

Paraméter Leírás
név (kötelező) Csatorna neve
leírás (opcionális) Csatorna leírása
szín (opcionális) Csatornajelvény színe (HEX)
Játszott (opcionális) Csillagozza meg a csatornát vagy sem (igaz vagy hamis)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \
--data-raw '{
    "name": "Új csatorna",
    "description": "az új csatornám",
    "color": "#000000",
    "csillagos": igaz
}' 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Új csatorna",
	    "description": "az új csatornám",
	    "color": "#000000",
	    "csillagos": igaz
	}',
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/add',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    törzs: JSON.stringify({
    "name": "Új csatorna",
    "description": "az új csatornám",
    "color": "#000000",
    "csillagos": igaz
}),
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/channel/add"
hasznos adat = {
    "name": "Új csatorna",
    "description": "az új csatornám",
    "color": "#000000",
    "csillagos": igaz
}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("POST", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var kérés = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var tartalom = new StringContent("{
    "name": "Új csatorna",
    "description": "az új csatornám",
    "color": "#000000",
    "csillagos": igaz
}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "id": 3,
    "name": "Új csatorna",
    "description": "az új csatornám",
    "color": "#000000",
    "csillagos": igaz
} 
Elem hozzárendelése csatornához
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Egy elem bármely csatornához hozzárendelhető a csatornaazonosítóval, az elem típusával (linkek, életrajz vagy qr) és a tételazonosítóval ellátott kérés elküldésével.

Paraméter Leírás
:csatorna azonosító (kötelező) Csatorna azonosítója
:típus (Kötelező) linkek vagy életrajz vagy QR-kód
:itemid (kötelező) Tétel azonosítója
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("POST", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "Az elem sikeresen hozzáadva a csatornához."
} 
Csatorna frissítése
PUT https://urlkai.com/api/channel/:id/update

Csatorna frissítéséhez érvényes adatokat kell küldenie JSON-ban egy PUT kérésen keresztül. Az adatokat a kérelem nyers törzseként kell elküldeni az alábbiak szerint. Az alábbi példa az összes elküldhető paramétert mutatja, de nem kell az összeset elküldenie (további információt a táblázatban talál).

Paraméter Leírás
név (opcionális) Csatorna neve
leírás (opcionális) Csatorna leírása
szín (opcionális) Csatornajelvény színe (HEX)
Játszott (opcionális) Csillagozza meg a csatornát vagy sem (igaz vagy hamis)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "csatorna az Acme Corp cikkeihez",
    "color": "#FFFFFF",
    "csillagos": hamis
}' 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Acme Corp",
	    "description": "csatorna az Acme Corp cikkeihez",
	    "color": "#FFFFFF",
	    "csillagos": hamis
	}',
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/channel/:id/update',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    törzs: JSON.stringify({
    "name": "Acme Corp",
    "description": "csatorna az Acme Corp cikkeihez",
    "color": "#FFFFFF",
    "csillagos": hamis
}),
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/channel/:id/update"
hasznos adat = {
    "name": "Acme Corp",
    "description": "csatorna az Acme Corp cikkeihez",
    "color": "#FFFFFF",
    "csillagos": hamis
}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("PUT", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var kérés = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var tartalom = new StringContent("{
    "name": "Acme Corp",
    "description": "csatorna az Acme Corp cikkeihez",
    "color": "#FFFFFF",
    "csillagos": hamis
}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "A csatorna frissítése sikeresen megtörtént."
} 
Csatorna törlése
DELETE https://urlkai.com/api/channel/:id/delete

Csatorna törléséhez TÖRLÉS kérést kell küldenie. Az összes elem hozzárendelése is megszűnik.

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "TÖRLÉS",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'TÖRLÉS',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/channel/:id/delete"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("DELETE", url, headers=headers, json=hasznos tartalom)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "A csatorna törlése sikeresen megtörtént."
} 

Egyedi csobbanás

Egyéni kezdőkép listázása
GET https://urlkai.com/api/splash?limit=2&page=1

Ha egyéni kezdőoldalakat szeretne lekérni az API-n keresztül, használhatja ezt a végpontot. Az adatokat szűrheti is (további információt a táblázatban talál).

Paraméter Leírás
korlát (opcionális) Oldalankénti adateredmény
oldal (opcionális) Aktuális oldal kérése
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/splash?limit=2&page=1"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("GET", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var kérés = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "error": "0",
    "data": {
        "eredmény": 2,
        "oldalanként": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "splash": [
            {
                "id": 1,
                "name": "1. termék promóció",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "2. termék promóciója",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Fájlokat

Fájlok listázása
GET https://urlkai.com/api/files?limit=2&page=1

Szerezze be az összes fájlt. Név szerint is kereshet.

Paraméter Leírás
név (opcionális) Fájl keresése név szerint
korlát (opcionális) Oldalankénti adateredmény
oldal (opcionális) Aktuális oldal kérése
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());
Szerver válasza
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/kmFhB",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/AKtYm",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/qHMvu",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
Fájl feltöltése
POST https://urlkai.com/api/files/upload/:filename?name=My+File

Töltsön fel egy fájlt úgy, hogy elküldi a bináris adatokat a bejegyzés törzseként. Az URL-ben a :filename helyett a fájlnevet kell elküldened a kiterjesztéssel együtt (pl. brandkit.zip). A beállításokat a következő paraméterek elküldésével adhatja meg.

Paraméter Leírás
név (opcionális) Fájlnév
szokás (opcionális) Egyéni alias véletlenszerű alias helyett.
tartomány (opcionális) Egyéni tartomány
jelszó (opcionális) Jelszavas védelem
Lejárat (opcionális) A letöltési példa lejárata 2021-09-28
MaxLetöltések (opcionális) Letöltések maximális száma
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());
Szerver válasza
{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/urlkai.com\/jZXAX"
}

Linkek


Pixel

Képpontok listázása
GET https://urlkai.com/api/pixels?limit=2&page=1

A képpontkódok API-n keresztüli lekéréséhez használhatja ezt a végpontot. Az adatokat szűrheti is (további információt a táblázatban talál).

Paraméter Leírás
korlát (opcionális) Oldalankénti adateredmény
oldal (opcionális) Aktuális oldal kérése
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/pixels?limit=2&page=1"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("GET", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "error": "0",
    "data": {
        "eredmény": 2,
        "oldalanként": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "pixels": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM Pixel",
                "tag": "GA-123456789",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "twitterpixel",
                "name": "Twitter Pixel",
                "tag": "1234567",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
} 
Képpont létrehozása
POST https://urlkai.com/api/pixel/add

Ezzel a végponttal képpont hozható létre. El kell küldenie a képpont típusát és a címkét.

Paraméter Leírás
típus (kötelező) gtmpixel | Gapixel | fbpixel | AdWordsPixel | linkedinpixel | Twitterpixel | AdrollPixel | Quorapixel | Pinterest | Bing | Snapchat | reddit | TikTok
név (kötelező) A képpont egyéni neve
címke (kötelező) A képpont címkéje
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "Az én GTM-em",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "gtmpixel",
	    "name": "Az én GTM-em",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/pixel/add',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    törzs: JSON.stringify({
    "type": "gtmpixel",
    "name": "Az én GTM-em",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/pixel/add"
hasznos adat = {
    "type": "gtmpixel",
    "name": "Az én GTM-em",
    "tag": "GTM-ABCDE"
}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("POST", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var tartalom = new StringContent("{
    "type": "gtmpixel",
    "name": "Az én GTM-em",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "id": 1
} 
Pixel frissítése
PUT https://urlkai.com/api/pixel/:id/update

A képpont frissítéséhez érvényes adatokat kell küldenie JSON-ban egy PUT-kérésen keresztül. Az adatokat a kérelem nyers törzseként kell elküldeni az alábbiak szerint. Az alábbi példa az összes elküldhető paramétert mutatja, de nem kell az összeset elküldenie (további információt a táblázatban talál).

Paraméter Leírás
név (opcionális) A képpont egyéni neve
címke (kötelező) A képpont címkéje
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \
--data-raw '{
    "name": "Az én GTM-em",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Az én GTM-em",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    törzs: JSON.stringify({
    "name": "Az én GTM-em",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/pixel/:id/update"
hasznos adat = {
    "name": "Az én GTM-em",
    "tag": "GTM-ABCDE"
}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("PUT", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var tartalom = new StringContent("{
    "name": "Az én GTM-em",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "A Pixel frissítése sikeresen megtörtént."
} 
Pixel törlése
DELETE https://urlkai.com/api/pixel/:id/delete

Képpont törléséhez TÖRLÉS kérést kell küldenie.

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "TÖRLÉS",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'TÖRLÉS',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/pixel/:id/delete"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("DELETE", url, headers=headers, json=hasznos tartalom)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "A pixel törlése sikeresen megtörtént."
} 

QR-kódok

QR-kódok listázása
GET https://urlkai.com/api/qr?limit=2&page=1

A QR-kódok API-n keresztüli beszerzéséhez használhatja ezt a végpontot. Az adatokat szűrheti is (további információt a táblázatban talál).

Paraméter Leírás
korlát (opcionális) Oldalankénti adateredmény
oldal (opcionális) Aktuális oldal kérése
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/qr?limit=2&page=1"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("GET", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "error": "0",
    "data": {
        "eredmény": 2,
        "oldalanként": 2,
        "currentpage": 1,
        "nextpage": 1,
        "maxpage": 1,
        "QRS": [
            {
                "id": 2,
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "szkennel": 0,
                "name": "Google",
                "date": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/urlkai.com\/qr\/b9edfe",
                "szkennel": 5,
                "name": "Google Kanada",
                "date": "2020-11-10 18:00:25"
            }
        ]
    }
} 
Szerezzen be egyetlen QR-kódot
GET https://urlkai.com/api/qr/:id

Ha egyetlen QR-kód részleteit szeretné lekérni az API-n keresztül, használhatja ezt a végpontot.

curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/qr/:id',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/qr/:id"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("GET", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "részletek": {
        "id": 1,
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "szkennel": 5,
        "name": "Google Kanada",
        "date": "2020-11-10 18:00:25"
    },
    "data": {
        "kattanások": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Ismeretlen": "1"
        },
        "topReferrers": {
            "Közvetlen, e-mail és egyéb": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "facebook": 0,
            "Twitter": 0,
            "Instagram": 0
        }
    }
} 
Hozzon létre egy QR-kódot
POST https://urlkai.com/api/qr/add

QR-kód létrehozásához érvényes adatokat kell küldenie JSON-ban egy POST-kérésen keresztül. Az adatokat a kérelem nyers törzseként kell elküldeni az alábbiak szerint. Az alábbi példa az összes elküldhető paramétert mutatja, de nem kell az összeset elküldenie (további információt a táblázatban talál).

Paraméter Leírás
típus (kötelező) szöveg | vCard | link | E-mail cím | telefon | SMS | WiFi
adat (kötelező) A QR-kódba beágyazandó adatok. Az adatok típustól függően lehetnek sztringek vagy tömbök
háttér (opcionális) RGB szín, pl. rgb(255,255,255)
előtér (opcionális) RGB szín, pl. rgb(0,0,0)
embléma (opcionális) Az embléma elérési útja png vagy jpg
név (opcionális) QR-kód neve
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "előtér": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QR Code API"
}' 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/qr/add",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "link",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "előtér": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": "QR Code API"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/qr/add',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    törzs: JSON.stringify({
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "előtér": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QR Code API"
}),
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/qr/add"
hasznos adat = {
    "type": "link",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "előtér": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png",
    "name": "QR Code API"
}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("POST", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var kérés = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var tartalom = new StringContent("{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "előtér": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QR Code API"
}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "id": 3,
    "link": "https:\/\/urlkai.com\/qr\/a58f79"
} 
QR-kód frissítése
PUT https://urlkai.com/api/qr/:id/update

A QR-kód frissítéséhez érvényes adatokat kell küldenie JSON-ban egy PUT kérésen keresztül. Az adatokat a kérelem nyers törzseként kell elküldeni az alábbiak szerint. Az alábbi példa az összes elküldhető paramétert mutatja, de nem kell az összeset elküldenie (további információt a táblázatban talál).

Paraméter Leírás
adat (kötelező) A QR-kódba beágyazandó adatok. Az adatok típustól függően lehetnek sztringek vagy tömbök
háttér (opcionális) RGB szín, pl. rgb(255,255,255)
előtér (opcionális) RGB szín, pl. rgb(0,0,0)
embléma (opcionális) Az embléma elérési útja png vagy jpg
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \
--data-raw '{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "előtér": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}' 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "link",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "előtér": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/qr/:id/update',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    törzs: JSON.stringify({
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "előtér": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/qr/:id/update"
hasznos adat = {
    "type": "link",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "előtér": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("PUT", url, headers=headers, json=payload)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var tartalom = new StringContent("{
    "type": "link",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "előtér": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "A QR-kód frissítése sikeresen megtörtént."
} 
QR-kód törlése
DELETE https://urlkai.com/api/qr/:id/delete

QR-kód törléséhez TÖRLÉS kérelmet kell küldenie.

curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Engedélyezés: Bearer YOURAPIKEY' \
--header 'Tartalomtípus: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, tömb(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => igaz,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION => igaz,
    CURLOPT_CUSTOMREQUEST => "TÖRLÉS",
    CURLOPT_HTTPHEADER => [
        "Meghatalmazás: Bearer YOURAPIKEY",
        "Tartalomtípus: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
visszhang $response; 
var kérés = require('kérés');
var opciók = {
    'method': 'TÖRLÉS',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'fejlécek': {
        "Meghatalmazás": "Hordozó YOURAPIKEY",
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    ha (hiba) dob új Error(error);
    console.log(válasz.test);
}); 
Kérelmek importálása
url = "https://urlkai.com/api/qr/:id/delete"
hasznos adat = {}
fejlécek = {
    "Meghatalmazás": "Hordozó YOURAPIKEY",
    'Content-Type': 'application/json'
}
válasz = requests.request("DELETE", url, headers=headers, json=hasznos tartalom)
nyomtatás(válasz.szöveg) 
var kliens = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
kérés. Headers.Add("Engedélyezés", "Hordozó YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
kérés. Tartalom = tartalom;
var válasz = várja meg az ügyfelet. SendAsync(kérés);
válasz. EnsureSuccessStatusCode();
Console.WriteLine(várja meg a választ. Content.ReadAsStringAsync()); 
Szerver válasza
{
    "hiba": 0,
    "message": "A QR-kód sikeresen törölve."
}