API-referentie voor ontwikkelaars

Slag

Een API-sleutel is vereist om aanvragen door het systeem te kunnen verwerken. Zodra een gebruiker zich registreert, wordt er automatisch een API-sleutel gegenereerd voor deze gebruiker. De API-sleutel moet bij elk verzoek worden meegestuurd (zie het volledige voorbeeld hieronder). Als de API-sleutel niet wordt verzonden of is verlopen, treedt er een fout op. Zorg ervoor dat u uw API-sleutel geheim houdt om misbruik te voorkomen.

Authenticatie

Als u zich wilt verifiëren bij het API-systeem, moet u uw API-sleutel bij elke aanvraag als autorisatietoken verzenden. U kunt de voorbeeldcode hieronder zien.

krul --locatie --verzoek POST 'https://urlkai.com/api/account' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
));

$response = curl_exec($curl); 
var request = require('verzoek');
var opties = {
    "methode": "POST",
    'url': 'https://urlkai.com/api/account',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    lichaam: ''
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/account"
laadvermogen = {}
koppen = {
  "Machtiging": "Toonder YOURAPIKEY",
  'Content-Type': 'applicatie/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Tarief limiet

Onze API heeft een snelheidsbegrenzer om te beschermen tegen pieken in verzoeken om de stabiliteit te maximaliseren. Onze snelheidsbegrenzer is momenteel beperkt tot 30 verzoeken per 1 minuut. Houd er rekening mee dat het tarief kan veranderen afhankelijk van het geabonneerde abonnement.

Samen met het antwoord worden verschillende headers verzonden en deze kunnen worden onderzocht om verschillende informatie over het verzoek te bepalen.

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Afhandeling van reacties

Alle API-responsen worden standaard geretourneerd in JSON-indeling. Om dit om te zetten in bruikbare gegevens, moet de juiste functie worden gebruikt, afhankelijk van de taal. In PHP kan de functie json_decode() worden gebruikt om de gegevens te converteren naar een object (standaard) of een array (stel de tweede parameter in op true). Het is erg belangrijk om de foutsleutel te controleren, omdat deze informatie geeft over of er een fout is opgetreden of niet. U kunt ook de koptekstcode controleren.

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

Rekening

Account krijgen
GET https://urlkai.com/api/account

Als u informatie over het account wilt krijgen, kunt u een verzoek naar dit eindpunt sturen en worden er gegevens over het account geretourneerd.

krul --locatie --verzoek GET 'https://urlkai.com/api/account' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "KRIJGEN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "method": "KRIJGEN",
    'url': 'https://urlkai.com/api/account',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/account"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "gegevens": {
        "id": 1,
        "e-mail": " [e-mail beveiligd] ",
        "username": "sampleuser",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "expires": "2022-11-15 15:00:00",
        "geregistreerd": "2020-11-10 18:01:43"
    }
} 
Account bijwerken
PUT https://urlkai.com/api/account/update

Als u de informatie over het account wilt bijwerken, kunt u een verzoek naar dit eindpunt sturen, waarna de gegevens op het account worden bijgewerkt.

krul --locatie --verzoek PUT 'https://urlkai.com/api/account/update' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "e-mail": " [e-mail beveiligd] ",
    "password": "nieuwwachtwoord"
}' 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "e-mail": " [e-mail beveiligd] ",
	    "password": "nieuwwachtwoord"
	}',
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "PUT",
    'url': 'https://urlkai.com/api/account/update',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    body: JSON.stringify({
    "e-mail": " [e-mail beveiligd] ",
    "password": "nieuwwachtwoord"
}),
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/account/update"
laadvermogen = {
    "e-mail": " [e-mail beveiligd] ",
    "password": "nieuwwachtwoord"
}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{
    "e-mail": " [e-mail beveiligd] ",
    "password": "nieuwwachtwoord"
}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "Account is bijgewerkt."
} 

Merkgebonden domeinen

Vermeld merkdomeinen
GET https://urlkai.com/api/domains?limit=2&page=1

Om uw merkdomeinen via de API te krijgen, kunt u dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
krul --locatie --verzoek GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "KRIJGEN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "method": "KRIJGEN",
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/domains?limit=2&page=1"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "error": "0",
    "gegevens": {
        "resultaat": 2,
        "perpage": 2,
        "huidigepagina": 1,
        "volgende pagina": 1,
        "maxpage": 1,
        "domeinen": [
            {
                "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"
            }
        ]
    }
} 
Maak een merkdomein
POST https://urlkai.com/api/domain/add

Met behulp van dit eindpunt kan een domein worden toegevoegd. Zorg ervoor dat het domein correct naar onze server verwijst.

Parameter Beschrijving
domein (verplicht) Merkdomein inclusief http of https
Root omleiden (optioneel) Root-omleiding wanneer iemand uw domein bezoekt
doorverwijzen 404 (optioneel) Aangepaste 404-omleiding
krul --locatie --verzoek POST 'https://urlkai.com/api/domain/add' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/domain/add",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "domain": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "POST",
    'url': 'https://urlkai.com/api/domain/add',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    body: JSON.stringify({
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/domain/add"
laadvermogen = {
    "domain": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{
    "domain": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "identiteitskaart": 1
} 
Domein bijwerken
PUT https://urlkai.com/api/domain/:id/update

Als u een merkdomein wilt bijwerken, moet u geldige gegevens in JSON verzenden via een PUT-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
Root omleiden (optioneel) Root-omleiding wanneer iemand uw domein bezoekt
doorverwijzen 404 (optioneel) Aangepaste 404-omleiding
krul --locatie --verzoek PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "PUT",
    'url': 'https://urlkai.com/api/domain/:id/update',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    body: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/domain/:id/update"
laadvermogen = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage (HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "Domein is bijgewerkt."
} 
Domein verwijderen
DELETE https://urlkai.com/api/domain/:id/delete

Als u een domein wilt verwijderen, moet u een DELETE-verzoek verzenden.

krul --locatie --verzoek DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "VERWIJDEREN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    'method': 'VERWIJDEREN',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/domain/:id/delete"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "Domein is succesvol verwijderd."
} 

CTA-overlays

Lijst CTA-overlays
GET https://urlkai.com/api/overlay?limit=2&page=1

Om cta-overlays via de API te krijgen, kunt u dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
krul --locatie --verzoek GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "KRIJGEN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "method": "KRIJGEN",
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/overlay?limit=2&page=1"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "error": "0",
    "gegevens": {
        "resultaat": 2,
        "perpage": 2,
        "huidigepagina": 1,
        "volgende pagina": 1,
        "maxpage": 1,
        "CTA": [
            {
                "id": 1,
                "type": "bericht",
                "name": "Product 1 Promo",
                "datum": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "contactpersoon",
                "name": "Pagina voor contactpersonen",
                "datum": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Campagnes

Campagnes weergeven
GET https://urlkai.com/api/campaigns?limit=2&page=1

Om je campagnes via de API te krijgen, kun je dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
curl --locatie --verzoek GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "KRIJGEN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "method": "KRIJGEN",
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "error": "0",
    "gegevens": {
        "resultaat": 2,
        "perpage": 2,
        "huidigepagina": 1,
        "volgende pagina": 1,
        "maxpage": 1,
        "campagnes": [
            {
                "id": 1,
                "name": "Voorbeeld campagne",
                "openbaar": onwaar,
                "rotator": onwaar,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Facebook-campagne",
                "openbaar": waar,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
Een campagne maken
POST https://urlkai.com/api/campaign/add

Met behulp van dit eindpunt kan een campagne worden toegevoegd.

Parameter Beschrijving
naam (optioneel) Naam van de campagne
naaktslak (optioneel) Rotator naaktslak
publiek (optioneel) Toegang
krul --locatie --verzoek POST 'https://urlkai.com/api/campaign/add' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nieuwe campagne",
    "slug": "nieuwe-campagne",
    "Publiek": waar
}' 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Nieuwe campagne",
	    "slug": "nieuwe-campagne",
	    "Publiek": waar
	}',
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "POST",
    'url': 'https://urlkai.com/api/campaign/add',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    body: JSON.stringify({
    "name": "Nieuwe campagne",
    "slug": "nieuwe-campagne",
    "Publiek": waar
}),
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/campaign/add"
laadvermogen = {
    "name": "Nieuwe campagne",
    "slug": "nieuwe-campagne",
    "Publiek": waar
}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{
    "name": "Nieuwe campagne",
    "slug": "nieuwe-campagne",
    "Publiek": waar
}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "identiteitskaart": 3,
    "domain": "Nieuwe campagne",
    "openbaar": waar,
    "rotator": "https:\/\/domain.com\/r\/nieuwe-campagne",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Met behulp van dit eindpunt kan een korte link aan een campagne worden toegewezen. Voor het eindpunt zijn de campagne-ID en de korte link-ID vereist.

curl --locatie --verzoek POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "POST",
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "Link succesvol toegevoegd aan de campagne."
} 
Update Campagne
PUT https://urlkai.com/api/campaign/:id/update

Om een campagne bij te werken, moet u geldige gegevens in JSON verzenden via een PUT-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
naam (verplicht) Naam van de campagne
naaktslak (optioneel) Rotator naaktslak
publiek (optioneel) Toegang
krul --locatie --verzoek PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Twitter-campagne",
    "slug": "Twitter-campagne",
    "Publiek": waar
}' 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Twitter-campagne",
	    "slug": "Twitter-campagne",
	    "Publiek": waar
	}',
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "PUT",
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    body: JSON.stringify({
    "name": "Twitter-campagne",
    "slug": "Twitter-campagne",
    "Publiek": waar
}),
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/campaign/:id/update"
laadvermogen = {
    "name": "Twitter-campagne",
    "slug": "Twitter-campagne",
    "Publiek": waar
}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{
    "name": "Twitter-campagne",
    "slug": "Twitter-campagne",
    "Publiek": waar
}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "identiteitskaart": 3,
    "domain": "Twitter-campagne",
    "openbaar": waar,
    "rotator": "https:\/\/domain.com\/r\/twitter-campagne",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
Campagne verwijderen
DELETE https://urlkai.com/api/campaign/:id/delete

Als u een campagne wilt verwijderen, moet u een DELETE-verzoek verzenden.

curl --locatie --verzoek DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "VERWIJDEREN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    'method': 'VERWIJDEREN',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/campaign/:id/delete"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "Campagne is succesvol verwijderd."
} 

Kanalen

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

Om je kanalen via de API te krijgen, kun je dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
krul --locatie --verzoek GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "KRIJGEN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "method": "KRIJGEN",
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/channels?limit=2&page=1"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "error": "0",
    "gegevens": {
        "resultaat": 2,
        "perpage": 2,
        "huidigepagina": 1,
        "volgende pagina": 1,
        "maxpage": 1,
        "kanalen": [
            {
                "id": 1,
                "name": "Kanaal 1",
                "description": "Beschrijving van kanaal 1",
                "kleur": "#000000",
                "Starred": waar
            },
            {
                "id": 2,
                "name": "Kanaal 2",
                "description": "Beschrijving van kanaal 2",
                "kleur": "#FF0000",
                "Starred": Onwaar
            }
        ]
    }
} 
Lijst van kanaalitems
GET https://urlkai.com/api/channel/:id?limit=1&page=1

Om items in een bepaald kanaal via de API te krijgen, kunt u dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
krul --locatie --verzoek GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "KRIJGEN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "method": "KRIJGEN",
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage (HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "error": "0",
    "gegevens": {
        "resultaat": 2,
        "perpage": 2,
        "huidigepagina": 1,
        "volgende pagina": 1,
        "maxpage": 1,
        "Artikelen": [
            {
                "type": "koppelingen",
                "id": 1,
                "title": "Mijn voorbeeldlink",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "datum": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "Mijn voorbeeldbio",
                "preview": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "datum": "2022-06-01"
            }
        ]
    }
} 
Een kanaal maken
POST https://urlkai.com/api/channel/add

Met behulp van dit eindpunt kan een kanaal worden toegevoegd.

Parameter Beschrijving
naam (verplicht) Naam van het kanaal
beschrijving (optioneel) Beschrijving van het kanaal
Kleur (optioneel) Kleur kanaalbadge (HEX)
Speelde (optioneel) Het kanaal een ster geven of niet (waar of niet waar)
krul --locatie --verzoek POST 'https://urlkai.com/api/channel/add' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nieuw kanaal",
    "description": "Mijn nieuwe kanaal",
    "kleur": "#000000",
    "Starred": waar
}' 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Nieuw kanaal",
	    "description": "Mijn nieuwe kanaal",
	    "kleur": "#000000",
	    "Starred": waar
	}',
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "POST",
    'url': 'https://urlkai.com/api/channel/add',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    body: JSON.stringify({
    "name": "Nieuw kanaal",
    "description": "Mijn nieuwe kanaal",
    "kleur": "#000000",
    "Starred": waar
}),
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/channel/add"
laadvermogen = {
    "name": "Nieuw kanaal",
    "description": "Mijn nieuwe kanaal",
    "kleur": "#000000",
    "Starred": waar
}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{
    "name": "Nieuw kanaal",
    "description": "Mijn nieuwe kanaal",
    "kleur": "#000000",
    "Starred": waar
}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "identiteitskaart": 3,
    "name": "Nieuw kanaal",
    "description": "Mijn nieuwe kanaal",
    "kleur": "#000000",
    "Starred": waar
} 
Een item aan een kanaal toewijzen
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Een item kan aan elk kanaal worden toegewezen door een verzoek te sturen met de kanaal-ID, het itemtype (links, bio of qr) en de item-ID.

Parameter Beschrijving
:kanaalid (verplicht) Kanaal-ID
:type (verplichte) links of bio of QR
:itemid (verplicht) Artikel-ID
krul --locatie --verzoek POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "POST",
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "Item succesvol toegevoegd aan het kanaal."
} 
Kanaal bijwerken
PUT https://urlkai.com/api/channel/:id/update

Als u een kanaal wilt bijwerken, moet u geldige gegevens in JSON verzenden via een PUT-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
naam (optioneel) Naam van het kanaal
beschrijving (optioneel) Beschrijving van het kanaal
Kleur (optioneel) Kleur kanaalbadge (HEX)
Speelde (optioneel) Het kanaal een ster geven of niet (waar of niet waar)
krul --locatie --verzoek PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "naam": "Acme Corp",
    "description": "kanaal voor artikelen voor Acme Corp",
    "kleur": "#FFFFFF",
    "Starred": Onwaar
}' 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "naam": "Acme Corp",
	    "description": "kanaal voor artikelen voor Acme Corp",
	    "kleur": "#FFFFFF",
	    "Starred": Onwaar
	}',
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "PUT",
    'url': 'https://urlkai.com/api/channel/:id/update',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    body: JSON.stringify({
    "naam": "Acme Corp",
    "description": "kanaal voor artikelen voor Acme Corp",
    "kleur": "#FFFFFF",
    "Starred": Onwaar
}),
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/channel/:id/update"
laadvermogen = {
    "naam": "Acme Corp",
    "description": "kanaal voor artikelen voor Acme Corp",
    "kleur": "#FFFFFF",
    "Starred": Onwaar
}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{
    "naam": "Acme Corp",
    "description": "kanaal voor artikelen voor Acme Corp",
    "kleur": "#FFFFFF",
    "Starred": Onwaar
}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "Kanaal is succesvol bijgewerkt."
} 
Kanaal verwijderen
DELETE https://urlkai.com/api/channel/:id/delete

Als je een kanaal wilt verwijderen, moet je een DELETE-verzoek verzenden. Alle items worden ook niet toegewezen.

krul --locatie --verzoek DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "VERWIJDEREN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    'method': 'VERWIJDEREN',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/channel/:id/delete"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "Kanaal is succesvol verwijderd."
} 

Aangepaste Splash

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

Als u aangepaste splash-pagina's wilt ophalen via de API, kunt u dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
krul --locatie --verzoek GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "KRIJGEN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "method": "KRIJGEN",
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/splash?limit=2&page=1"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage (HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "error": "0",
    "gegevens": {
        "resultaat": 2,
        "perpage": 2,
        "huidigepagina": 1,
        "volgende pagina": 1,
        "maxpage": 1,
        "plons": [
            {
                "id": 1,
                "name": "Product 1 Promo",
                "datum": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Product 2 Promo",
                "datum": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Files

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

Get all of your files. You can also search by name.

Parameter Beschrijving
naam (optional) Search for a file by name
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
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());
Antwoord van de server
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/Jwqim",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/AHoty",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/ydeiu",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
Upload a file
POST https://urlkai.com/api/files/upload/:filename?name=My+File

Upload a file by sending the binary data as the post body. You need to send the file name including the extension instead of :filename in the url (e.g. brandkit.zip). You can set options by sending the following parameters.

Parameter Beschrijving
naam (optional) File name
gewoonte (optioneel) Aangepaste alias in plaats van willekeurige alias.
domein (optioneel) Aangepast domein
wachtwoord (optioneel) Wachtwoord beveiliging
Verstrijken (optional) Expiration for the download example 2021-09-28
maxdownloads (optional) Maximum number of downloads
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());
Antwoord van de server
{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/urlkai.com\/QVHLh"
}

Verwijzigingen


Pixels

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

Om je pixelcodes via de API te krijgen, kun je dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
krul --locatie --verzoek GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "KRIJGEN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "method": "KRIJGEN",
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/pixels?limit=2&page=1"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "error": "0",
    "gegevens": {
        "resultaat": 2,
        "perpage": 2,
        "huidigepagina": 1,
        "volgende pagina": 1,
        "maxpage": 1,
        "pixels": [
            {
                "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"
            }
        ]
    }
} 
Een pixel maken
POST https://urlkai.com/api/pixel/add

Met behulp van dit eindpunt kan een pixel worden gemaakt. U moet het pixeltype en de tag verzenden.

Parameter Beschrijving
type (verplicht) gtmpixel | Gapixel | fbpixel | adwordspixel | linkedinpixel | Twitteren Pixel | adrollpixel | Quorapixel | Pinterest Nederland | Bing Nederland | Snapchat | Reddit | Tiktok
naam (verplicht) Aangepaste naam voor je pixel
label (verplicht) De tag voor de pixel
krul --locatie --verzoek POST 'https://urlkai.com/api/pixel/add' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "Mijn GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "gtmpixel",
	    "name": "Mijn GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "POST",
    'url': 'https://urlkai.com/api/pixel/add',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    body: JSON.stringify({
    "type": "gtmpixel",
    "name": "Mijn GTM",
    "tag": "GTM-ABCDE"
}),
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/pixel/add"
laadvermogen = {
    "type": "gtmpixel",
    "name": "Mijn GTM",
    "tag": "GTM-ABCDE"
}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{
    "type": "gtmpixel",
    "name": "Mijn GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "identiteitskaart": 1
} 
Pixel bijwerken
PUT https://urlkai.com/api/pixel/:id/update

Als u een pixel wilt bijwerken, moet u geldige gegevens in JSON verzenden via een PUT-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
naam (optioneel) Aangepaste naam voor je pixel
label (verplicht) De tag voor de pixel
krul --locatie --verzoek PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Mijn GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Mijn GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "PUT",
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    body: JSON.stringify({
    "name": "Mijn GTM",
    "tag": "GTM-ABCDE"
}),
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/pixel/:id/update"
laadvermogen = {
    "name": "Mijn GTM",
    "tag": "GTM-ABCDE"
}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{
    "name": "Mijn GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "Pixel is bijgewerkt."
} 
Pixel verwijderen
DELETE https://urlkai.com/api/pixel/:id/delete

Als u een pixel wilt verwijderen, moet u een DELETE-verzoek verzenden.

krul --locatie --verzoek DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "VERWIJDEREN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    'method': 'VERWIJDEREN',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/pixel/:id/delete"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "Pixel is succesvol verwijderd."
} 

QR-codes

Lijst QR-codes
GET https://urlkai.com/api/qr?limit=2&page=1

Om je QR-codes via de API te krijgen, kun je dit eindpunt gebruiken. U kunt ook gegevens filteren (zie tabel voor meer informatie).

Parameter Beschrijving
grens (optioneel) Resultaat gegevens per pagina
bladzijde (optioneel) Huidige pagina aanvraag
krul --locatie --verzoek GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "KRIJGEN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "method": "KRIJGEN",
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/qr?limit=2&page=1"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "error": "0",
    "gegevens": {
        "resultaat": 2,
        "perpage": 2,
        "huidigepagina": 1,
        "volgende pagina": 1,
        "maxpage": 1,
        "QRS": [
            {
                "id": 2,
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "scans": 0,
                "name": "Google",
                "datum": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/urlkai.com\/qr\/b9edfe",
                "scans": 5,
                "name": "Google Canada",
                "datum": "2020-11-10 18:00:25"
            }
        ]
    }
} 
Ontvang een enkele QR-code
GET https://urlkai.com/api/qr/:id

Om via de API details te krijgen voor een enkele QR-code, kunt u dit eindpunt gebruiken.

curl --locatie --verzoek GET 'https://urlkai.com/api/qr/:id' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "KRIJGEN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "method": "KRIJGEN",
    'url': 'https://urlkai.com/api/qr/:id',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/qr/:id"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "Details": {
        "id": 1,
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "scans": 5,
        "name": "Google Canada",
        "datum": "2020-11-10 18:00:25"
    },
    "gegevens": {
        "klikken": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Onbekend": "1"
        },
        "topReferrers": {
            "Direct, e-mail en overige": "1"
        },
        "topBrowsers": {
            "Chroom": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "facebook": 0,
            "Twitter": 0,
            "Instagram": 0
        }
    }
} 
Maak een QR-code
POST https://urlkai.com/api/qr/add

Om een QR-code te maken, moet u geldige gegevens in JSON verzenden via een POST-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
type (verplichte) tekst | vcard | koppeling | E-mailadres | telefoon | sms | Wifi
gegevens (verplicht) Gegevens die in de QR-code moeten worden ingesloten. De gegevens kunnen een string of array zijn, afhankelijk van het type
achtergrond (optioneel) RGB-kleur, bijv. rgb (255.255.255)
voorgrond (optioneel) RGB-kleur, bijv. rgb(0,0,0)
logo (optioneel) Pad naar het logo, png of jpg
naam (optioneel) Naam QR-code
krul --locatie --verzoek POST 'https://urlkai.com/api/qr/add' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "koppeling",
    "data": "https:\/\/google.com",
    "background": "rgb(255.255.255)",
    "voorgrond": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QR-code API"
}' 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/qr/add",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "koppeling",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255.255.255)",
	    "voorgrond": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": "QR-code API"
	}',
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "POST",
    'url': 'https://urlkai.com/api/qr/add',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    body: JSON.stringify({
    "type": "koppeling",
    "data": "https:\/\/google.com",
    "background": "rgb(255.255.255)",
    "voorgrond": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QR-code API"
}),
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/qr/add"
laadvermogen = {
    "type": "koppeling",
    "gegevens": "https://google.com",
    "background": "rgb(255.255.255)",
    "voorgrond": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png",
    "name": "QR-code API"
}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{
    "type": "koppeling",
    "data": "https:\/\/google.com",
    "background": "rgb(255.255.255)",
    "voorgrond": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QR-code API"
}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "identiteitskaart": 3,
    "link": "https:\/\/urlkai.com\/qr\/a58f79"
} 
QR-code bijwerken
PUT https://urlkai.com/api/qr/:id/update

Om een QR-code bij te werken, moet u geldige gegevens in JSON verzenden via een PUT-verzoek. De gegevens moeten worden verzonden als de ruwe tekst van uw verzoek, zoals hieronder weergegeven. Het onderstaande voorbeeld toont alle parameters die u kunt verzenden, maar u bent niet verplicht om alles te verzenden (zie tabel voor meer informatie).

Parameter Beschrijving
gegevens (verplicht) Gegevens die in de QR-code moeten worden ingesloten. De gegevens kunnen een string of array zijn, afhankelijk van het type
achtergrond (optioneel) RGB-kleur, bijv. rgb (255.255.255)
voorgrond (optioneel) RGB-kleur, bijv. rgb(0,0,0)
logo (optioneel) Pad naar het logo, png of jpg
krul --locatie --verzoek PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "koppeling",
    "data": "https:\/\/google.com",
    "background": "rgb(255.255.255)",
    "voorgrond": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}' 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "koppeling",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255.255.255)",
	    "voorgrond": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    "methode": "PUT",
    'url': 'https://urlkai.com/api/qr/:id/update',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    body: JSON.stringify({
    "type": "koppeling",
    "data": "https:\/\/google.com",
    "background": "rgb(255.255.255)",
    "voorgrond": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/qr/:id/update"
laadvermogen = {
    "type": "koppeling",
    "gegevens": "https://google.com",
    "background": "rgb(255.255.255)",
    "voorgrond": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("PUT", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{
    "type": "koppeling",
    "data": "https:\/\/google.com",
    "background": "rgb(255.255.255)",
    "voorgrond": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "QR is bijgewerkt."
} 
Een QR-code verwijderen
DELETE https://urlkai.com/api/qr/:id/delete

Om een QR-code te verwijderen, moet u een DELETE-verzoek verzenden.

krul --locatie --verzoek DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Machtiging: Toonder YOURAPIKEY' \
--header 'Content-Type: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => waar,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => waar,
    CURLOPT_CUSTOMREQUEST => "VERWIJDEREN",
    CURLOPT_HTTPHEADER => [
        "Machtiging: Toonder YOURAPIKEY",
        "Inhoud-Type: applicatie/json",
    ],
    
));

$response = curl_exec($curl);

curl_close, lid $curl);
echo $response; 
var request = require('verzoek');
var opties = {
    'method': 'VERWIJDEREN',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'koppen': {
        "Machtiging": "Toonder YOURAPIKEY",
        'Content-Type': 'applicatie/json'
    },
    
};
request(opties, functie (fout, antwoord) {
    als (fout) nieuwe Fout (fout) gooit;
    console.log(reactie.lichaam);
}); 
Import aanvragen
url = "https://urlkai.com/api/qr/:id/delete"
laadvermogen = {}
koppen = {
    "Machtiging": "Toonder YOURAPIKEY",
    'Content-Type': 'applicatie/json'
}
response = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = nieuwe HttpClient();
var request = nieuw HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
verzoek. Headers.Add("Autorisatie", "Toonder YOURAPIKEY");
var content = nieuwe StringContent("{}", System.Text.Encoding.UTF8, "application/json");
verzoek. Inhoud = inhoud;
var response = wachten op client. SendAsync(verzoek);
antwoord. EnsureSuccessStatusCode();
Console.WriteLine(wacht op antwoord. Inhoud.ReadAsStringAsync()); 
Antwoord van de server
{
    "fout": 0,
    "message": "QR-code is succesvol verwijderd."
}