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 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, Array(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "POST",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
));

$response = curl_exec($curl); 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/account',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Körper: ''
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
URL = "https://urlkai.com/api/account"
Nutzlast = {}
Kopfzeilen = {
  'Authorization': 'Inhaber YOURAPIKEY',
  'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("ABRUFEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.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. Bitte beachten Sie, dass sich der Tarif je nach abonniertem Plan ändern kann.

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

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

Um benutzerdefinierte Begrüßungsseiten über die API abzurufen, können Sie diesen Endpunkt verwenden. Sie können Daten auch filtern (weitere Informationen finden Sie in der Tabelle).

Parameter Beschreibung
Grenze (fakultativ) Datenergebnis pro Seite
Seite (fakultativ) Aktueller Seitenaufruf
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/splash?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "HOLEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'Methode': 'ABRUFEN',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/splash?limit=2&page=1"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("ABRUFEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": "0",
    "Daten": {
        "Ergebnis": 2,
        "pro Seite": 2,
        "aktuelleSeite": 1,
        "nächste Seite": 1,
        "maxpage": 1,
        "platsch": [
            {
                "id": 1,
                "name": "Produkt 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "name": "Produkt 2 Promo",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
} 

CTA-Overlays

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

Um CTA-Overlays über die API zu erhalten, können Sie diesen Endpunkt verwenden. Sie können Daten auch filtern (weitere Informationen finden Sie in der Tabelle).

Parameter Beschreibung
Grenze (fakultativ) Datenergebnis pro Seite
Seite (fakultativ) Aktueller Seitenaufruf
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/overlay?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "HOLEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'Methode': 'ABRUFEN',
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/overlay?limit=2&page=1"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("ABRUFEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": "0",
    "Daten": {
        "Ergebnis": 2,
        "pro Seite": 2,
        "aktuelleSeite": 1,
        "nächste Seite": 1,
        "maxpage": 1,
        "cta": [
            {
                "id": 1,
                "type": "Nachricht",
                "name": "Produkt 1 Promo",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "Kontakt",
                "name": "Kontaktseite",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
} 

Kampagnen

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

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

Parameter Beschreibung
Grenze (fakultativ) Datenergebnis pro Seite
Seite (fakultativ) Aktueller Seitenaufruf
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/campaigns?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "HOLEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'Methode': 'ABRUFEN',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("ABRUFEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": "0",
    "Daten": {
        "Ergebnis": 2,
        "pro Seite": 2,
        "aktuelleSeite": 1,
        "nächste Seite": 1,
        "maxpage": 1,
        "Kampagnen": [
            {
                "id": 1,
                "name": "Beispielkampagne",
                "public": falsch,
                "rotator": falsch,
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "id": 2,
                "domain": "Facebook-Kampagne",
                "public": wahr,
                "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

Mit diesem Endpunkt kann eine Kampagne hinzugefügt werden.

Parameter Beschreibung
Name (fakultativ) Name der Kampagne
Nacktschnecke (fakultativ) Rotator-Butzen
Öffentlich (fakultativ) Zugang
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \
--data-raw '{
    "name": "Neue Kampagne",
    "slug": "neue-kampagne",
    "public": wahr
}' 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/campaign/add",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "POST",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    CURLOPT_POSTFIELDS = > 
        '{
	    "name": "Neue Kampagne",
	    "slug": "neue-kampagne",
	    "public": wahr
	}',
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/add',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Text: JSON.stringify({
    "name": "Neue Kampagne",
    "slug": "neue-kampagne",
    "public": wahr
}),
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
URL = "https://urlkai.com/api/campaign/add"
Nutzlast = {
    "name": "Neue Kampagne",
    "slug": "neue-kampagne",
    "public": wahr
}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("POST", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "Neue Kampagne",
    "slug": "neue-kampagne",
    "public": wahr
}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "id": 3,
    "domain": "Neue Kampagne",
    "public": wahr,
    "rotator": "https:\/\/domain.com\/r\/new-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/new-campaign-3"
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

Über diesen Endpunkt kann einer Kampagne ein Kurzlink zugeordnet werden. Der Endpunkt benötigt die Kampagnen-ID und die Kurzlink-ID.

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/campaign/:campaignid/assign/:linkid",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "POST",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("POST", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "Link erfolgreich zur Kampagne hinzugefügt."
} 
Kampagne aktualisieren
PUT https://urlkai.com/api/campaign/:id/update

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

Parameter Beschreibung
Name (erforderlich) Name der Kampagne
Nacktschnecke (fakultativ) Rotator-Butzen
Öffentlich (fakultativ) Zugang
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \
--data-raw '{
    "name": "Twitter-Kampagne",
    "slug": "Twitter-Kampagne",
    "public": wahr
}' 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/campaign/:id/update",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "SETZEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    CURLOPT_POSTFIELDS = > 
        '{
	    "name": "Twitter-Kampagne",
	    "slug": "Twitter-Kampagne",
	    "public": wahr
	}',
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'SETZEN',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Text: JSON.stringify({
    "name": "Twitter-Kampagne",
    "slug": "Twitter-Kampagne",
    "public": wahr
}),
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/campaign/:id/update"
Nutzlast = {
    "name": "Twitter-Kampagne",
    "slug": "Twitter-Kampagne",
    "public": wahr
}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("SETZEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "Twitter-Kampagne",
    "slug": "Twitter-Kampagne",
    "public": wahr
}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "id": 3,
    "domain": "Twitter-Kampagne",
    "public": wahr,
    "rotator": "https:\/\/domain.com\/r\/twitter-kampagne",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
} 
Kampagne löschen
DELETE https://urlkai.com/api/campaign/:id/delete

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

curl --location --request DELETE 'https://urlkai.com/api/campaign/:id/delete' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/campaign/:id/delete",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "LÖSCHEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'LÖSCHEN',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
URL = "https://urlkai.com/api/campaign/:id/delete"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("LÖSCHEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "Die Kampagne wurde erfolgreich gelöscht."
} 

Kanäle

Kanäle auflisten
GET https://urlkai.com/api/channels?limit=2&page=1

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

Parameter Beschreibung
Grenze (fakultativ) Datenergebnis pro Seite
Seite (fakultativ) Aktueller Seitenaufruf
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/channels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "HOLEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'Methode': 'ABRUFEN',
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/channels?limit=2&page=1"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("ABRUFEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": "0",
    "Daten": {
        "Ergebnis": 2,
        "pro Seite": 2,
        "aktuelleSeite": 1,
        "nächste Seite": 1,
        "maxpage": 1,
        "Kanäle": [
            {
                "id": 1,
                "name": "Kanal 1",
                "description": "Beschreibung von Kanal 1",
                "color": "#000000",
                "sternchen": wahr
            },
            {
                "id": 2,
                "name": "Kanal 2",
                "description": "Beschreibung von Kanal 2",
                "color": "#FF0000",
                "stared": falsch
            }
        ]
    }
} 
Auflisten von Kanalelementen
GET https://urlkai.com/api/channel/:id?limit=1&page=1

Um Artikel in ausgewählten Kanälen über die API abzurufen, können Sie diesen Endpunkt verwenden. Sie können Daten auch filtern (weitere Informationen finden Sie in der Tabelle).

Parameter Beschreibung
Grenze (fakultativ) Datenergebnis pro Seite
Seite (fakultativ) Aktueller Seitenaufruf
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/channel/:id?limit=1&page=1",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "HOLEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'Methode': 'ABRUFEN',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("ABRUFEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": "0",
    "Daten": {
        "Ergebnis": 2,
        "pro Seite": 2,
        "aktuelleSeite": 1,
        "nächste Seite": 1,
        "maxpage": 1,
        "Artikel": [
            {
                "type": "Verknüpfungen",
                "id": 1,
                "title": "Mein Beispiel-Link",
                "preview": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "Datum": "12.05.2022"
            },
            {
                "type": "bio",
                "id": 1,
                "title": "Meine Beispiel-Biografie",
                "preview": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "Datum": "01.06.2022"
            }
        ]
    }
} 
Erstellen Sie einen Kanal
POST https://urlkai.com/api/channel/add

Mit diesem Endpunkt kann ein Kanal hinzugefügt werden.

Parameter Beschreibung
Name (erforderlich) Name des Kanals
Beschreibung (fakultativ) Beschreibung des Kanals
Farbe (fakultativ) Farbe des Kanal-Badges (HEX)
mit Sternzeichen versehen (fakultativ) Den Kanal mit einem Stern versehen oder nicht (wahr oder falsch)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \
--data-raw '{
    "name": "Neuer Kanal",
    "description": "Mein neuer Kanal",
    "color": "#000000",
    "sternchen": wahr
}' 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL => "https://urlkai.com/api/channel/add",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "POST",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    CURLOPT_POSTFIELDS = > 
        '{
	    "name": "Neuer Kanal",
	    "description": "Mein neuer Kanal",
	    "color": "#000000",
	    "sternchen": wahr
	}',
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/add',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Text: JSON.stringify({
    "name": "Neuer Kanal",
    "description": "Mein neuer Kanal",
    "color": "#000000",
    "sternchen": wahr
}),
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/channel/add"
Nutzlast = {
    "name": "Neuer Kanal",
    "description": "Mein neuer Kanal",
    "color": "#000000",
    "sternchen": wahr
}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("POST", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "Neuer Kanal",
    "description": "Mein neuer Kanal",
    "color": "#000000",
    "sternchen": wahr
}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "id": 3,
    "name": "Neuer Kanal",
    "description": "Mein neuer Kanal",
    "color": "#000000",
    "sternchen": wahr
} 
Zuweisen eines Elements zu einem Kanal
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

Ein Artikel kann einem beliebigen Kanal zugewiesen werden, indem eine Anfrage mit der Kanal-ID, dem Artikeltyp (Links, Biografie oder QR) und der Artikel-ID gesendet wird.

Parameter Beschreibung
:channelid (erforderlich) Kanal-ID
:Art (erforderliche) Links oder Biografie oder QR
:itemid (erforderlich) Artikel-ID
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "POST",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("POST", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "Element erfolgreich zum Kanal hinzugefügt."
} 
Kanal aktualisieren
PUT https://urlkai.com/api/channel/:id/update

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

Parameter Beschreibung
Name (fakultativ) Name des Kanals
Beschreibung (fakultativ) Beschreibung des Kanals
Farbe (fakultativ) Farbe des Kanal-Badges (HEX)
mit Sternzeichen versehen (fakultativ) Den Kanal mit einem Stern versehen oder nicht (wahr oder falsch)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \
--data-raw '{
    "name": "Acme Corp",
    "description": "Kanal für Artikel für Acme Corp",
    "color": "#FFFFFF",
    "stared": falsch
}' 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/channel/:id/update",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "SETZEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    CURLOPT_POSTFIELDS = > 
        '{
	    "name": "Acme Corp",
	    "description": "Kanal für Artikel für Acme Corp",
	    "color": "#FFFFFF",
	    "stared": falsch
	}',
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'SETZEN',
    'url': 'https://urlkai.com/api/channel/:id/update',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Text: JSON.stringify({
    "name": "Acme Corp",
    "description": "Kanal für Artikel für Acme Corp",
    "color": "#FFFFFF",
    "stared": falsch
}),
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/channel/:id/update"
Nutzlast = {
    "name": "Acme Corp",
    "description": "Kanal für Artikel für Acme Corp",
    "color": "#FFFFFF",
    "stared": falsch
}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("SETZEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "Acme Corp",
    "description": "Kanal für Artikel für Acme Corp",
    "color": "#FFFFFF",
    "stared": falsch
}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "Der Kanal wurde erfolgreich aktualisiert."
} 
Kanal löschen
DELETE https://urlkai.com/api/channel/:id/delete

Um einen Kanal zu löschen, müssen Sie eine DELETE-Anfrage senden. Alle Elemente werden ebenfalls nicht zugewiesen.

curl --location --request DELETE 'https://urlkai.com/api/channel/:id/delete' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/channel/:id/delete",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "LÖSCHEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'LÖSCHEN',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/channel/:id/delete"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("LÖSCHEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "Der Kanal wurde erfolgreich gelöscht."
} 

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 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL => "https://urlkai.com/api/account",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "HOLEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'Methode': 'ABRUFEN',
    'url': 'https://urlkai.com/api/account',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
URL = "https://urlkai.com/api/account"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("ABRUFEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "Daten": {
        "id": 1,
        "E-Mail": " [E-Mail geschützt] ",
        "Benutzername": "Musterbenutzer",
        "avatar": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "expires": "2022-11-15 15:00:00",
        "registriert": "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 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \
--data-raw '{
    "E-Mail": " [E-Mail geschützt] ",
    "password": "neuesPasswort"
}' 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/account/update",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "SETZEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    CURLOPT_POSTFIELDS = > 
        '{
	    "E-Mail": " [E-Mail geschützt] ",
	    "password": "neuesPasswort"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'SETZEN',
    'url': 'https://urlkai.com/api/account/update',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Text: JSON.stringify({
    "E-Mail": " [E-Mail geschützt] ",
    "password": "neuesPasswort"
}),
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
URL = "https://urlkai.com/api/account/update"
Nutzlast = {
    "E-Mail": " [E-Mail geschützt] ",
    "password": "neuesPasswort"
}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("SETZEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "E-Mail": " [E-Mail geschützt] ",
    "password": "neuesPasswort"
}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "Das Konto wurde erfolgreich aktualisiert."
} 

Markendomänen

Auflisten von Markendomains
GET https://urlkai.com/api/domains?limit=2&page=1

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

Parameter Beschreibung
Grenze (fakultativ) Datenergebnis pro Seite
Seite (fakultativ) Aktueller Seitenaufruf
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/domains?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "HOLEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'Methode': 'ABRUFEN',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/domains?limit=2&page=1"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("ABRUFEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": "0",
    "Daten": {
        "Ergebnis": 2,
        "pro Seite": 2,
        "aktuelleSeite": 1,
        "nächste Seite": 1,
        "maxpage": 1,
        "Domänen": [
            {
                "id": 1,
                "Domäne": "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"
            }
        ]
    }
} 
Erstellen einer Markendomain
POST https://urlkai.com/api/domain/add

Mit diesem Endpunkt kann eine Domäne hinzugefügt werden. Bitte stellen Sie sicher, dass die Domain korrekt auf unseren Server verweist.

Parameter Beschreibung
Domäne (erforderlich) Markendomain einschließlich http oder https
redirectroot (fakultativ) Root-Weiterleitung, wenn jemand Ihre Domain besucht
Weiterleitung404 (fakultativ) Benutzerdefinierte 404-Weiterleitung
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \
--data-raw '{
    "Domäne": "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 => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "POST",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    CURLOPT_POSTFIELDS = > 
        '{
	    "Domäne": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/domain/add',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Text: JSON.stringify({
    "Domäne": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/domain/add"
Nutzlast = {
    "domain": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("POST", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "Domäne": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "ID": 1
} 
Domäne aktualisieren
PUT https://urlkai.com/api/domain/:id/update

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

Parameter Beschreibung
redirectroot (fakultativ) Root-Weiterleitung, wenn jemand Ihre Domain besucht
Weiterleitung404 (fakultativ) Benutzerdefinierte 404-Weiterleitung
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: 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 => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "SETZEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    CURLOPT_POSTFIELDS = > 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'SETZEN',
    'url': 'https://urlkai.com/api/domain/:id/update',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Text: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/domain/:id/update"
Nutzlast = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("SETZEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "Die Domain wurde erfolgreich aktualisiert."
} 
Domäne löschen
DELETE https://urlkai.com/api/domain/:id/delete

Um eine Domäne zu löschen, müssen Sie eine DELETE-Anforderung senden.

curl --location --request DELETE 'https://urlkai.com/api/domain/:id/delete' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL => "https://urlkai.com/api/domain/:id/delete",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "LÖSCHEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'LÖSCHEN',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/domain/:id/delete"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("LÖSCHEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "Domain wurde erfolgreich gelöscht."
} 

Pixel

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

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

Parameter Beschreibung
Grenze (fakultativ) Datenergebnis pro Seite
Seite (fakultativ) Aktueller Seitenaufruf
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/pixels?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "HOLEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'Methode': 'ABRUFEN',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/pixels?limit=2&page=1"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("ABRUFEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": "0",
    "Daten": {
        "Ergebnis": 2,
        "pro Seite": 2,
        "aktuelleSeite": 1,
        "nächste Seite": 1,
        "maxpage": 1,
        "Pixel": [
            {
                "id": 1,
                "type": "gtmpixel",
                "name": "GTM-Pixel",
                "tag": "GA-123456789",
                "date": "2020-11-10 18:00:00"
            },
            {
                "id": 2,
                "type": "TwitterPixel",
                "name": "Twitter-Pixel",
                "tag": "1234567",
                "date": "2020-11-10 18:10:00"
            }
        ]
    }
} 
Erstellen eines Pixels
POST https://urlkai.com/api/pixel/add

Mit diesem Endpunkt kann ein Pixel erstellt werden. Sie müssen den Pixeltyp und das Tag senden.

Parameter Beschreibung
Art (erforderlich) gtmpixel | Gapixel | fbpixel | AdwordsPixel | LinkedInPixel | TwitterPixel | adrollpixel | Quorapixel | Pinterest | Bing | Snapchat | reddit | Tiktok (Englisch)
Name (erforderlich) Benutzerdefinierter Name für dein Pixel
Etikett (erforderlich) Das Tag für das Pixel
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \
--data-raw '{
    "type": "gtmpixel",
    "name": "Mein GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/pixel/add",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "POST",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    CURLOPT_POSTFIELDS = > 
        '{
	    "type": "gtmpixel",
	    "name": "Mein GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/pixel/add',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Text: JSON.stringify({
    "type": "gtmpixel",
    "name": "Mein GTM",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/pixel/add"
Nutzlast = {
    "type": "gtmpixel",
    "name": "Mein GTM",
    "tag": "GTM-ABCDE"
}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("POST", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "type": "gtmpixel",
    "name": "Mein GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "ID": 1
} 
Pixel aktualisieren
PUT https://urlkai.com/api/pixel/:id/update

Um ein Pixel zu aktualisieren, musst du gültige Daten in JSON über eine PUT-Anfrage senden. Die Daten müssen als Rohtext Ihrer Anfrage gesendet werden, wie unten gezeigt. Das folgende Beispiel zeigt alle Parameter, die Sie senden können, aber Sie müssen nicht alle senden (weitere Informationen finden Sie in der Tabelle).

Parameter Beschreibung
Name (fakultativ) Benutzerdefinierter Name für dein Pixel
Etikett (erforderlich) Das Tag für das Pixel
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \
--data-raw '{
    "name": "Mein GTM",
    "tag": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "SETZEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    CURLOPT_POSTFIELDS = > 
        '{
	    "name": "Mein GTM",
	    "tag": "GTM-ABCDE"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'SETZEN',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Text: JSON.stringify({
    "name": "Mein GTM",
    "tag": "GTM-ABCDE"
}),
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/pixel/:id/update"
Nutzlast = {
    "name": "Mein GTM",
    "tag": "GTM-ABCDE"
}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("SETZEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "name": "Mein GTM",
    "tag": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "Das Pixel wurde erfolgreich aktualisiert."
} 
Pixel löschen
DELETE https://urlkai.com/api/pixel/:id/delete

Um ein Pixel zu löschen, musst du eine DELETE-Anfrage senden.

curl --location --request DELETE 'https://urlkai.com/api/pixel/:id/delete' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/pixel/:id/delete",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "LÖSCHEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'LÖSCHEN',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/pixel/:id/delete"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("LÖSCHEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "Das Pixel wurde erfolgreich gelöscht."
} 

QR-Codes

QR-Codes auflisten
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).

Parameter Beschreibung
Grenze (fakultativ) Datenergebnis pro Seite
Seite (fakultativ) Aktueller Seitenaufruf
curl --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/qr?limit=2&page=1",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "HOLEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'Methode': 'ABRUFEN',
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/qr?limit=2&page=1"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("ABRUFEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": "0",
    "Daten": {
        "Ergebnis": 2,
        "pro Seite": 2,
        "aktuelleSeite": 1,
        "nächste Seite": 1,
        "maxpage": 1,
        "qrs": [
            {
                "id": 2,
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "scans": 0,
                "name": "Google",
                "date": "2020-11-10 18:01:43"
            },
            {
                "id": 1,
                "link": "https:\/\/urlkai.com\/qr\/b9edfe",
                "scans": 5,
                "name": "Google Kanada",
                "date": "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 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "HOLEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'Methode': 'ABRUFEN',
    'url': 'https://urlkai.com/api/qr/:id',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/qr/:id"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("ABRUFEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "details": {
        "id": 1,
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "scans": 5,
        "name": "Google Kanada",
        "date": "2020-11-10 18:00:25"
    },
    "Daten": {
        "Klicks": 1,
        "uniqueClicks": 1,
        "topLänder": {
            "Unbekannt": "1"
        },
        "topReferrer": {
            "Direkt, E-Mail und andere": "1"
        },
        "topBrowsers": {
            "Chrom": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "facebook": 0,
            "twitter": 0,
            "Instagram": 0
        }
    }
} 
Erstellen Sie einen QR-Code
POST https://urlkai.com/api/qr/add

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

Parameter Beschreibung
Art (erforderlicher) Text | VCARD | Verknüpfung | E-Mail | Telefon | SMS | WLAN
Daten (erforderlich) Daten, die in den QR-Code eingebettet werden sollen. Die Daten können je nach Typ eine Zeichenfolge oder ein Array sein
Hintergrund (fakultativ) RGB-Farbe z.B. RGB (255,255,255)
Vordergrund (fakultativ) RGB-Farbe z.B. rgb(0,0,0)
Logo (fakultativ) Pfad zum Logo entweder png oder jpg
Name (fakultativ) QR-Code-Name
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \
--data-raw '{
    "type": "Verknüpfung",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "Vordergrund": "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 => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "POST",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    CURLOPT_POSTFIELDS = > 
        '{
	    "type": "Verknüpfung",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "Vordergrund": "RGB(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "name": "QR-Code-API"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/qr/add',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Text: JSON.stringify({
    "type": "Verknüpfung",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "Vordergrund": "RGB(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QR-Code-API"
}),
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/qr/add"
Nutzlast = {
    "type": "Verknüpfung",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "Vordergrund": "RGB(0,0,0)",
    "logo": "https://site.com/logo.png",
    "name": "QR-Code-API"
}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("POST", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "type": "Verknüpfung",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "Vordergrund": "RGB(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "name": "QR-Code-API"
}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "id": 3,
    "link": "https:\/\/urlkai.com\/qr\/a58f79"
} 
QR-Code aktualisieren
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).

Parameter Beschreibung
Daten (erforderlich) Daten, die in den QR-Code eingebettet werden sollen. Die Daten können je nach Typ eine Zeichenfolge oder ein Array sein
Hintergrund (fakultativ) RGB-Farbe z.B. RGB (255,255,255)
Vordergrund (fakultativ) RGB-Farbe z.B. rgb(0,0,0)
Logo (fakultativ) Pfad zum Logo entweder png oder jpg
curl --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \
--data-raw '{
    "type": "Verknüpfung",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "Vordergrund": "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 => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "SETZEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    CURLOPT_POSTFIELDS = > 
        '{
	    "type": "Verknüpfung",
	    "data": "https:\/\/google.com",
	    "background": "rgb(255,255,255)",
	    "Vordergrund": "RGB(0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'SETZEN',
    'url': 'https://urlkai.com/api/qr/:id/update',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    Text: JSON.stringify({
    "type": "Verknüpfung",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "Vordergrund": "RGB(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/qr/:id/update"
Nutzlast = {
    "type": "Verknüpfung",
    "data": "https://google.com",
    "background": "rgb(255,255,255)",
    "Vordergrund": "RGB(0,0,0)",
    "logo": "https://site.com/logo.png"
}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("SETZEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{
    "type": "Verknüpfung",
    "data": "https:\/\/google.com",
    "background": "rgb(255,255,255)",
    "Vordergrund": "RGB(0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "QR wurde erfolgreich aktualisiert."
} 
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 'Autorisierung: Träger YOURAPIKEY' \
--header 'Inhaltstyp: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, Array(
    CURLOPT_URL = > "https://urlkai.com/api/qr/:id/delete",
    CURLOPT_RETURNTRANSFER => wahr,
    CURLOPT_MAXREDIRS = > 2,
    CURLOPT_TIMEOUT = > 10,
    CURLOPT_FOLLOWLOCATION = > wahr,
    CURLOPT_CUSTOMREQUEST = > "LÖSCHEN",
    CURLOPT_HTTPHEADER = > [
        "Autorisierung: Inhaber YOURAPIKEY",
        "Inhaltstyp: application/json",
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
Echo $response; 
var Anfrage = require('Anforderung');
var Optionen = {
    'method': 'LÖSCHEN',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'Kopfzeilen': {
        'Authorization': 'Inhaber YOURAPIKEY',
        'Inhaltstyp': 'Anwendung/json'
    },
    
};
request(options, function (error, response) {
    if (Fehler) throw new Error(error);
    console.log(Antwort.Körper);
}); 
Aufträge importieren
url = "https://urlkai.com/api/qr/:id/delete"
Nutzlast = {}
Kopfzeilen = {
    'Authorization': 'Inhaber YOURAPIKEY',
    'Inhaltstyp': 'Anwendung/json'
}
Antwort = requests.request("LÖSCHEN", url, headers=headers, json=nutzlast)
drucken(Antwort.text) 
var client = neu HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
bitten. Headers.Add("Autorisierung", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "Anwendung/json");
bitten. Inhalt = Inhalt;
var response = await client. SendAsync(Anforderung);
Antwort. EnsureSuccessStatusCode();
Console.WriteLine(Warten auf Antwort. Inhalt.ReadAsStringAsync()); 
Antwort des Servers
{
    "Fehler": 0,
    "message": "QR-Code wurde erfolgreich gelöscht."
} 

Verknüpfungen