API-Referenz für Entwickler

Einstieg

Damit Anfragen vom System verarbeitet werden können, ist ein API-Schlüssel erforderlich. Sobald sich ein Benutzer registriert, wird automatisch ein API-Schlüssel für diesen Benutzer generiert. Der API-Schlüssel muss mit jeder Anfrage gesendet werden (siehe vollständiges Beispiel unten). Wenn der API-Schlüssel nicht gesendet wird oder abgelaufen ist, wird ein Fehler angezeigt. Bitte achten Sie darauf, Ihren API-Schlüssel geheim zu halten, um Missbrauch zu verhindern.

Authentifizierung

Um sich beim API-System zu authentifizieren, müssen Sie bei jeder Anfrage Ihren API-Schlüssel als Autorisierungstoken senden. Unten sehen Sie einen Beispielcode.

curl --location --request POST 'https://urlkai.com/api/account' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();
curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "MISSATGE",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
));

$response = curl_exec($curl); 
var request = require('request');
var opcions = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/account',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: ''
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/account"
càrrega útil = {}
capçaleres = {
  'Autorització': 'Portador YOURAPIKEY',
  'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Bewertungslimit

Unsere API verfügt über einen Ratenbegrenzer zum Schutz vor Anfragenspitzen, um ihre Stabilität zu maximieren. Unser Ratenbegrenzer ist derzeit auf 30 Anfragen pro 1 Minute begrenzt. Tingues en compte que la tarifa pot variar segons el pla subscrit.

Neben der Antwort werden mehrere Header gesendet, die untersucht werden können, um verschiedene Informationen über die Anfrage zu ermitteln.

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Antwortbehandlung

Alle API-Antworten werden standardmäßig im JSON-Format zurückgegeben. Um diese in verwertbare Daten umzuwandeln, muss je nach Sprache die entsprechende Funktion verwendet werden. In PHP kann die Funktion json_decode() verwendet werden, um die Daten entweder in ein Objekt (Standard) oder ein Array (den zweiten Parameter auf true zu setzen) zu konvertieren. Es ist sehr wichtig, den Fehlerschlüssel zu überprüfen, da er Auskunft darüber gibt, ob ein Fehler aufgetreten ist oder nicht. Sie können auch den Header-Code überprüfen.

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

Benutzerdefinierter Splash

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

Per obtenir pàgines de presentació personalitzades mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).

Paràmetre Beschreibung
límit (opcional) Resultat de dades per pàgina
pàgina (opcional) Sol·licitud de pàgina actual
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "OBTENIR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/splash?limit=2&page=1"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": "0",
    "dades": {
        "resultat": 2,
        "perpage": 2,
        "pàgina actual": 1,
        "pàgina següent": 1,
        "maxpage": 1,
        "esquitxada": [
            {
                "id": 1,
                "name": "Promoció del producte 1",
                "data": "2020-11-10 18:00:00"
            },
            {
                "identificació": 2,
                "name": "Promoció del producte 2",
                "data": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Superposicions de CTA

Llista de superposicions de CTA
GET https://urlkai.com/api/overlay?limit=2&page=1

Per obtenir superposicions de CTA mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).

Paràmetre Beschreibung
límit (opcional) Resultat de dades per pàgina
pàgina (opcional) Sol·licitud de pàgina actual
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "OBTENIR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/overlay?limit=2&page=1"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": "0",
    "dades": {
        "resultat": 2,
        "perpage": 2,
        "pàgina actual": 1,
        "pàgina següent": 1,
        "maxpage": 1,
        "cta": [
            {
                "id": 1,
                "type": "missatge",
                "name": "Promoció del producte 1",
                "data": "2020-11-10 18:00:00"
            },
            {
                "identificació": 2,
                "type": "contacte",
                "name": "Pàgina de contacte",
                "data": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Kampagnen

Llista de campanyes
GET https://urlkai.com/api/campaigns?limit=2&page=1

Per obtenir les campanyes a través de l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).

Paràmetre Beschreibung
límit (opcional) Resultat de dades per pàgina
pàgina (opcional) Sol·licitud de pàgina actual
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "OBTENIR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": "0",
    "dades": {
        "resultat": 2,
        "perpage": 2,
        "pàgina actual": 1,
        "pàgina següent": 1,
        "maxpage": 1,
        "campanyes": [
            {
                "id": 1,
                "name": "Campanya de mostra",
                "públic": fals,
                "rotador": fals,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "identificació": 2,
                "domain": "Campanya de Facebook",
                "públic": cert,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
} 
Erstellen Sie eine Kampagne
POST https://urlkai.com/api/campaign/add

Es pot afegir una campanya mitjançant aquest punt final.

Paràmetre Beschreibung
nom (opcional) Nom de la campanya
llimac (opcional) Llimac rotador
públic (opcional) Accés
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
    "name": "Nova campanya",
    "llimac": "nova campanya",
    "públic": cert
}' 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "MISSATGE",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Nova campanya",
	    "llimac": "nova campanya",
	    "públic": cert
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/add',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: JSON.stringify({
    "name": "Nova campanya",
    "llimac": "nova campanya",
    "públic": cert
}),
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/campaign/add"
càrrega útil = {
    "name": "Nova campanya",
    "llimac": "nova campanya",
    "públic": cert
}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
    "name": "Nova campanya",
    "llimac": "nova campanya",
    "públic": cert
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "identificació": 3,
    "domain": "Nova campanya",
    "públic": cert,
    "rotator": "https:\/\/domain.com\/r\/nova-campanya",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Es pot assignar un enllaç curt a una campanya mitjançant aquest punt final. El punt final requereix l'identificador de campanya i l'identificador d'enllaç curt.

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "MISSATGE",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "Enllaç afegit correctament a la campanya".
} 
Kampagne aktualisieren
PUT https://urlkai.com/api/campaign/:id/update

Per actualitzar una campanya, heu d'enviar dades vàlides en JSON mitjançant una sol·licitud PUT. Les dades s'han d'enviar com a cos brut de la vostra sol·licitud tal com es mostra a continuació. L'exemple següent mostra tots els paràmetres que podeu enviar però no esteu obligats a enviar-los tots (vegeu la taula per a més informació).

Paràmetre Beschreibung
nom (obligatori) Nom de la campanya
llimac (opcional) Llimac rotador
públic (opcional) Accés
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
    "name": "Campanya de Twitter",
    "llimac": "campanya de Twitter",
    "públic": cert
}' 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "POSAR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Campanya de Twitter",
	    "llimac": "campanya de Twitter",
	    "públic": cert
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: JSON.stringify({
    "name": "Campanya de Twitter",
    "llimac": "campanya de Twitter",
    "públic": cert
}),
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/campaign/:id/update"
càrrega útil = {
    "name": "Campanya de Twitter",
    "llimac": "campanya de Twitter",
    "públic": cert
}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
    "name": "Campanya de Twitter",
    "llimac": "campanya de Twitter",
    "públic": cert
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "identificació": 3,
    "domain": "Campanya de Twitter",
    "públic": cert,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
Suprimeix la campanya
DELETE https://urlkai.com/api/campaign/:id/delete

Per suprimir una campanya, heu d'enviar una sol·licitud de supressió.

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "ESBORRAR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'SUPRIMEIX',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/campaign/:id/delete"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("DELETE", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "La campanya s'ha suprimit correctament".
} 

Kanäle

Llista de canals
GET https://urlkai.com/api/channels?limit=2&page=1

Per obtenir els vostres canals mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).

Paràmetre Beschreibung
límit (opcional) Resultat de dades per pàgina
pàgina (opcional) Sol·licitud de pàgina actual
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "OBTENIR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/channels?limit=2&page=1"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": "0",
    "dades": {
        "resultat": 2,
        "perpage": 2,
        "pàgina actual": 1,
        "pàgina següent": 1,
        "maxpage": 1,
        "canals": [
            {
                "id": 1,
                "name": "Canal 1",
                "description": "Descripció del canal 1",
                "color": "#000000",
                "Starred": Cert
            },
            {
                "identificació": 2,
                "name": "Canal 2",
                "description": "Descripció del canal 2",
                "color": "#FF0000",
                "Starred": fals
            }
        ]
    }
} 
Llista d'elements del canal
GET https://urlkai.com/api/channel/:id?limit=1&page=1

Per obtenir elements en un canal seleccionat mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).

Paràmetre Beschreibung
límit (opcional) Resultat de dades per pàgina
pàgina (opcional) Sol·licitud de pàgina actual
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "OBTENIR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": "0",
    "dades": {
        "resultat": 2,
        "perpage": 2,
        "pàgina actual": 1,
        "pàgina següent": 1,
        "maxpage": 1,
        "articles": [
            {
                "type": "enllaços",
                "id": 1,
                "title": "El meu enllaç de mostra",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "data": "2022-05-12"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "La meva biografia de mostra",
                "preview": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "data": "2022-06-01"
            }
        ]
    }
} 
Erstellen Sie einen Kanal
POST https://urlkai.com/api/channel/add

Es pot afegir un canal mitjançant aquest punt final.

Paràmetre Beschreibung
nom (obligatori) Nom del canal
descripció (opcional) Descripció del canal
color (opcional) Color de la insígnia del canal (HEX)
Protagonista (opcional) Estrella del canal o no (cert o fals)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
    "name": "Canal nou",
    "description": "el meu nou canal",
    "color": "#000000",
    "Starred": Cert
}' 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "MISSATGE",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Canal nou",
	    "description": "el meu nou canal",
	    "color": "#000000",
	    "Starred": Cert
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/add',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: JSON.stringify({
    "name": "Canal nou",
    "description": "el meu nou canal",
    "color": "#000000",
    "Starred": Cert
}),
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/channel/add"
càrrega útil = {
    "name": "Canal nou",
    "description": "el meu nou canal",
    "color": "#000000",
    "Starred": Cert
}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
    "name": "Canal nou",
    "description": "el meu nou canal",
    "color": "#000000",
    "Starred": Cert
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "identificació": 3,
    "name": "Canal nou",
    "description": "el meu nou canal",
    "color": "#000000",
    "Starred": Cert
} 
Assignar un element a un canal
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Es pot assignar un element a qualsevol canal enviant una sol·licitud amb l'identificador del canal, el tipus d'element (enllaços, biografia o qr) i l'identificador de l'element.

Paràmetre Beschreibung
:identificador de canal (obligatori) Identificador del canal
:tipus (obligatori) Enllaços o biografia o QR
:itemid (obligatori) Identificador de l'element
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "MISSATGE",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "L'element s'ha afegit correctament al canal".
} 
Kanal aktualisieren
PUT https://urlkai.com/api/channel/:id/update

Per actualitzar un canal, heu d'enviar dades vàlides en JSON mitjançant una sol·licitud PUT. Les dades s'han d'enviar com a cos brut de la vostra sol·licitud tal com es mostra a continuació. L'exemple següent mostra tots els paràmetres que podeu enviar però no esteu obligats a enviar-los tots (vegeu la taula per a més informació).

Paràmetre Beschreibung
nom (opcional) Nom del canal
descripció (opcional) Descripció del canal
color (opcional) Color de la insígnia del canal (HEX)
Protagonista (opcional) Estrella del canal o no (cert o fals)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "canal d'articles per a Acme Corp",
    "color": "#FFFFFF",
    "Starred": fals
}' 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "POSAR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "Acme Corp",
	    "description": "canal d'articles per a Acme Corp",
	    "color": "#FFFFFF",
	    "Starred": fals
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/channel/:id/update',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: JSON.stringify({
    "name": "Acme Corp",
    "description": "canal d'articles per a Acme Corp",
    "color": "#FFFFFF",
    "Starred": fals
}),
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/channel/:id/update"
càrrega útil = {
    "name": "Acme Corp",
    "description": "canal d'articles per a Acme Corp",
    "color": "#FFFFFF",
    "Starred": fals
}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
    "name": "Acme Corp",
    "description": "canal d'articles per a Acme Corp",
    "color": "#FFFFFF",
    "Starred": fals
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "El canal s'ha actualitzat correctament".
} 
Suprimeix el canal
DELETE https://urlkai.com/api/channel/:id/delete

Per suprimir un canal, heu d'enviar una sol·licitud de supressió. Tots els elements també es desassignaran.

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "ESBORRAR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'SUPRIMEIX',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/channel/:id/delete"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("DELETE", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "El canal s'ha suprimit correctament".
} 

Konto

Konto erhalten
GET https://urlkai.com/api/account

Um Informationen über das Konto zu erhalten, können Sie eine Anfrage an diesen Endpunkt senden, der Daten über das Konto zurückgibt.

curl --location --request GET 'https://urlkai.com/api/account' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "OBTENIR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/account',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/account"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "dades": {
        "id": 1,
        "correu electrònic": " [protegit per correu electrònic] ",
        "nom d'usuari": "usuarisample",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "caduca": "2022-11-15 15:00:00",
        "Registrat": "2020-11-10 18:01:43"
    }
} 
Account aktualisieren
PUT https://urlkai.com/api/account/update

Um Informationen zu dem Konto zu aktualisieren, können Sie eine Anfrage an diesen Endpunkt senden und er aktualisiert die Daten zu dem Konto.

curl --location --request PUT 'https://urlkai.com/api/account/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
    "correu electrònic": " [protegit per correu electrònic] ",
    "password": "contrasenya nova"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "POSAR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "correu electrònic": " [protegit per correu electrònic] ",
	    "password": "contrasenya nova"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/account/update',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: JSON.stringify({
    "correu electrònic": " [protegit per correu electrònic] ",
    "password": "contrasenya nova"
}),
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/account/update"
càrrega útil = {
    "correu electrònic": " [protegit per correu electrònic] ",
    "password": "contrasenya nova"
}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
    "correu electrònic": " [protegit per correu electrònic] ",
    "password": "contrasenya nova"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "El compte s'ha actualitzat correctament".
} 

Markendomänen

Llista de dominis de marca
GET https://urlkai.com/api/domains?limit=2&page=1

Per obtenir els vostres dominis de marca mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).

Paràmetre Beschreibung
límit (opcional) Resultat de dades per pàgina
pàgina (opcional) Sol·licitud de pàgina actual
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "OBTENIR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/domains?limit=2&page=1"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": "0",
    "dades": {
        "resultat": 2,
        "perpage": 2,
        "pàgina actual": 1,
        "pàgina següent": 1,
        "maxpage": 1,
        "dominis": [
            {
                "id": 1,
                "domini": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "identificació": 2,
                "domini": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
} 
Crear un domini de marca
POST https://urlkai.com/api/domain/add

Es pot afegir un domini mitjançant aquest punt final. Si us plau, assegureu-vos que el domini estigui correctament apuntat al nostre servidor.

Paràmetre Beschreibung
domini (obligatori) Domini de marca que inclou http o https
redireccióarrel (opcional) Redirecció arrel quan algú visita el vostre domini
redirecció404 (opcional) Redirecció 404 personalitzada
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
    "domini": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/domain/add",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "MISSATGE",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "domini": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/domain/add',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: JSON.stringify({
    "domini": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/domain/add"
càrrega útil = {
    "domini": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
    "domini": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "identificació": 1
} 
Domäne aktualisieren
PUT https://urlkai.com/api/domain/:id/update

Per actualitzar un domini de marca, heu d'enviar dades vàlides en JSON mitjançant una sol·licitud PUT. Les dades s'han d'enviar com a cos brut de la vostra sol·licitud tal com es mostra a continuació. L'exemple següent mostra tots els paràmetres que podeu enviar però no esteu obligats a enviar-los tots (vegeu la taula per a més informació).

Paràmetre Beschreibung
redireccióarrel (opcional) Redirecció arrel quan algú visita el vostre domini
redirecció404 (opcional) Redirecció 404 personalitzada
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/update",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "POSAR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/domain/:id/update',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/domain/:id/update"
càrrega útil = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "El domini s'ha actualitzat correctament".
} 
Suprimeix el domini
DELETE https://urlkai.com/api/domain/:id/delete

Per suprimir un domini, heu d'enviar una sol·licitud de supressió.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "ESBORRAR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'SUPRIMEIX',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/domain/:id/delete"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("DELETE", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "El domini s'ha suprimit correctament".
} 

Píxel

Píxels de llista
GET https://urlkai.com/api/pixels?limit=2&page=1

Per obtenir els vostres codis de píxels mitjançant l'API, podeu utilitzar aquest punt final. També podeu filtrar dades (vegeu la taula per obtenir més informació).

Paràmetre Beschreibung
límit (opcional) Resultat de dades per pàgina
pàgina (opcional) Sol·licitud de pàgina actual
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "OBTENIR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/pixels?limit=2&page=1"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": "0",
    "dades": {
        "resultat": 2,
        "perpage": 2,
        "pàgina actual": 1,
        "pàgina següent": 1,
        "maxpage": 1,
        "píxels": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "Píxel GTM",
                "tag": "GA-123456789",
                "data": "2020-11-10 18:00:00"
            },
            {
                "identificació": 2,
                "type": "twitterpixel",
                "name": "píxel de Twitter",
                "tag": "1234567",
                "data": "2020-11-10 18:10:00"
            }
        ]
    }
} 
Crear un píxel
POST https://urlkai.com/api/pixel/add

Es pot crear un píxel amb aquest punt final. Heu d'enviar el tipus de píxel i l'etiqueta.

Paràmetre Beschreibung
tipus (obligatori) gtmpixel | Gapixel | fbpixel | AdwordsPixel | LinkedInPixel | Píxel de Twitter | AdrollPixel | quorapíxel | Pinterest | Bing | Xat de Snap | reddit | TikTok
nom (obligatori) Nom personalitzat per al píxel
etiqueta (obligatori) L'etiqueta del píxel
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "El meu GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "MISSATGE",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "gtmpixel",
	    "name": "El meu GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/pixel/add',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: JSON.stringify({
    "type": "gtmpixel",
    "name": "El meu GTM",
    "tag": "GTM-ABCDE"
}),
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/pixel/add"
càrrega útil = {
    "type": "gtmpixel",
    "name": "El meu GTM",
    "tag": "GTM-ABCDE"
}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
    "type": "gtmpixel",
    "name": "El meu GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "identificació": 1
} 
Pixel aktualisieren
PUT https://urlkai.com/api/pixel/:id/update

Per actualitzar un píxel, heu d'enviar dades vàlides en JSON mitjançant una sol·licitud PUT. Les dades s'han d'enviar com a cos brut de la vostra sol·licitud tal com es mostra a continuació. L'exemple següent mostra tots els paràmetres que podeu enviar però no esteu obligats a enviar-los tots (vegeu la taula per a més informació).

Paràmetre Beschreibung
nom (opcional) Nom personalitzat per al píxel
etiqueta (obligatori) L'etiqueta del píxel
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
    "name": "El meu GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "POSAR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "El meu GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: JSON.stringify({
    "name": "El meu GTM",
    "tag": "GTM-ABCDE"
}),
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/pixel/:id/update"
càrrega útil = {
    "name": "El meu GTM",
    "tag": "GTM-ABCDE"
}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
    "name": "El meu GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "El píxel s'ha actualitzat correctament".
} 
Suprimeix el píxel
DELETE https://urlkai.com/api/pixel/:id/delete

Per suprimir un píxel, heu d'enviar una sol·licitud DELETE.

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "ESBORRAR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'SUPRIMEIX',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/pixel/:id/delete"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("DELETE", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "Pixel s'ha suprimit correctament".
} 

Codis QR

Llista de codis QR
GET https://urlkai.com/api/qr?limit=2&page=1

Um Ihre QR-Codes über die API abzurufen, können Sie diesen Endpunkt verwenden. Sie können Daten auch filtern (weitere Informationen finden Sie in der Tabelle).

Paràmetre Beschreibung
límit (opcional) Resultat de dades per pàgina
pàgina (opcional) Sol·licitud de pàgina actual
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "OBTENIR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/qr?limit=2&page=1"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": "0",
    "dades": {
        "resultat": 2,
        "perpage": 2,
        "pàgina actual": 1,
        "pàgina següent": 1,
        "maxpage": 1,
        "qrs": [
            {
                "identificació": 2,
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "escaneigs": 0,
                "name": "Google",
                "data": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "enllaç": "https:\/\/urlkai.com\/qr\/b9edfe",
                "escaneigs": 5,
                "name": "Google Canadà",
                "data": "2020-11-10 18:00:25"
            }
        ]
    }
} 
Holen Sie sich einen einzigen QR-Code
GET https://urlkai.com/api/qr/:id

Um Details für einen einzelnen QR-Code über die API abzurufen, können Sie diesen Endpunkt verwenden.

curl --location --request GET 'https://urlkai.com/api/qr/:id' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "OBTENIR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/qr/:id',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/qr/:id"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("GET", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "detalls": {
        "id": 1,
        "enllaç": "https:\/\/urlkai.com\/qr\/b9edfe",
        "escaneigs": 5,
        "name": "Google Canadà",
        "data": "2020-11-10 18:00:25"
    },
    "dades": {
        "clics": 1,
        "uniqueClicks": 1,
        "topCountries": {
            "Desconegut": "1"
        },
        "topReferrers": {
            "Directe, correu electrònic i altres": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "Facebook": 0,
            "Twitter": 0,
            "Instagram": 0
        }
    }
} 
Erstellen Sie einen QR-Code
POST https://urlkai.com/api/qr/add

Per crear un codi QR, heu d'enviar dades vàlides en JSON mitjançant una sol·licitud POST. Les dades s'han d'enviar com a cos brut de la vostra sol·licitud tal com es mostra a continuació. L'exemple següent mostra tots els paràmetres que podeu enviar però no esteu obligats a enviar-los tots (vegeu la taula per a més informació).

Paràmetre Beschreibung
tipus text (obligatori) | vcard | Enllaç | correu electrònic | telèfon | Sms | Wifi
dades (obligatori) Dades a incrustar dins del codi QR. Les dades poden ser de cadena o matriu segons el tipus
fons (opcional) Color RGB, per exemple, rgb (255,255,255)
Primer pla (opcional) Color RGB, per exemple, rgb(0,0,0)
logo (opcional) Camí cap al logotip png o jpg
nom (opcional) Nom del codi QR
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
    "type": "enllaç",
    "dades": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API de codi QR"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/qr/add",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "MISSATGE",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "enllaç",
	    "dades": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "foreground": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": "API de codi QR"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/qr/add',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: JSON.stringify({
    "type": "enllaç",
    "dades": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API de codi QR"
}),
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/qr/add"
càrrega útil = {
    "type": "enllaç",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png",
    "name": "API de codi QR"
}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("POST", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
    "type": "enllaç",
    "dades": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "API de codi QR"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "identificació": 3,
    "enllaç": "https:\/\/urlkai.com\/qr\/a58f79"
} 
Actualitzar el codi QR
PUT https://urlkai.com/api/qr/:id/update

Um einen QR-Code zu aktualisieren, müssen Sie gültige Daten in JSON über eine PUT-Anforderung senden. Die Daten müssen wie unten gezeigt als Rohtext Ihrer Anfrage gesendet werden. Das folgende Beispiel zeigt alle Parameter, die Sie senden können, aber Sie müssen nicht alle senden (siehe Tabelle für weitere Informationen).

Paràmetre Beschreibung
dades (obligatori) Dades a incrustar dins del codi QR. Les dades poden ser de cadena o matriu segons el tipus
fons (opcional) Color RGB, per exemple, rgb (255,255,255)
Primer pla (opcional) Color RGB, per exemple, rgb(0,0,0)
logo (opcional) Camí cap al logotip png o jpg
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \
--data-raw '{
    "type": "enllaç",
    "dades": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}' 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/update",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "POSAR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "type": "enllaç",
	    "dades": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "foreground": "rgb(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'PUT',
    'url': 'https://urlkai.com/api/qr/:id/update',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    cos: JSON.stringify({
    "type": "enllaç",
    "dades": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/qr/:id/update"
càrrega útil = {
    "type": "enllaç",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https://site.com/logo.png"
}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("PUT", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{
    "type": "enllaç",
    "dades": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "foreground": "rgb(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "aplicació/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "El QR s'ha actualitzat correctament".
} 
Löschen Sie einen QR-Code
DELETE https://urlkai.com/api/qr/:id/delete

Um einen QR-Code zu löschen, müssen Sie eine DELETE-Anfrage senden.

curl --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header 'Autorització: Portador YOURAPIKEY' \
--header 'Tipus de contingut: aplicació/json' \ 
$curl = curl_init();

curl_setopt_array($curl, matriu(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => cert,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => cert,
    CURLOPT_CUSTOMREQUEST => "ESBORRAR",
    CURLOPT_HTTPHEADER => [
        "Autorització: Portador YOURAPIKEY",
        "Tipus de contingut: aplicació/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
ressò $response; 
var request = require('request');
var opcions = {
    'method': 'SUPRIMEIX',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'capçaleres': {
        'Autorització': 'Portador YOURAPIKEY',
        'Tipus de contingut': 'aplicació/json'
    },
    
};
sol·licitud(opcions, funció (error, resposta) {
    if (error) llança un nou error (error);
    console.log(resposta.cos);
}); 
Sol·licituds d'importació
url = "https://urlkai.com/api/qr/:id/delete"
càrrega útil = {}
capçaleres = {
    'Autorització': 'Portador YOURAPIKEY',
    'Tipus de contingut': 'aplicació/json'
}
resposta = requests.request("DELETE", url, headers=headers, json=payload)
print(resposta.text) 
var client = nou HttpClient();
var request = nou HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
demanar. Headers.Add("Autorització", "Portador YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
demanar. Contingut = contingut;
var resposta = esperar el client. SendAsync(sol·licitud);
resposta. EnsureSuccessStatusCode();
Console.WriteLine(await la resposta. Content.ReadAsStringAsync()); 
Antwort des Servers
{
    "error": 0,
    "message": "El codi QR s'ha suprimit correctament".
} 

Verknüpfungen