Empezando Autenticación Límite de tarifa Manejo de respuestas
Campañas
Canales
Cuenta
Códigos QR
Dominios de marca
Enlaces
Files
Personalizar página de bienvenida
العنصورات
Superposiciones de CTA

Referencia de API para desarrolladores

Empezando

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

Autenticación

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

cURL PHP Node.js Python C# 
curl - الموقع - طلب POST "https://urlkai.com/api/account" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();
curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/account" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "POST" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
));

$response = curl_exec ($curl) ؛ 
var request = require('request');
خيارات var = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/account',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: ''
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/account"
الحمولة = {}
الرؤوس = {
  'التفويض': 'حامله يورابيكي',
  "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Límite de tarifa

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

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

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

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

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

Campañas

قائمة الحملات
GET https://urlkai.com/api/campaigns?limit=2&page=1

للحصول على حملاتك عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
حد (اختياري) نتيجة بيانات لكل صفحة
صفحة (اختياري) طلب الصفحة الحالية
cURL PHP Node.js Python C# 
curl - الموقع - طلب الحصول على "https://urlkai.com/api/campaigns?limit=2&page=1" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/campaigns?limit=2&page=1" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "GET" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/campaigns?limit=2&page=1"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/campaigns?limit=2&page=1");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "error": "0",
    "البيانات": {
        "النتيجة": 2 ،
        "perpage": 2 ،
        "الصفحة الحالية": 1,
        "الصفحة التالية": 1,
        "maxpage": 1 ،
        "الحملات": [
            {
                "المعرف": 1 ،
                "name": "عينة حملة",
                "عام": خطأ ،
                "الدوار": خطأ ،
                "list": "https:\/\/domain.com\/u\/admin\/list-1"
            },
            {
                "المعرف": 2 ،
                "domain": "حملة فيسبوك",
                "عام": صحيح,
                "rotator": "https:\/\/domain.com\/r\/test",
                "list": "https:\/\/domain.com\/u\/admin\/test-2"
            }
        ]
    }
}
Crear una campaña
POST https://urlkai.com/api/campaign/add

يمكن إضافة حملة باستخدام نقطة النهاية هذه.

ParámetroDescripción
اسم (اختياري) اسم الحملة
سبيكه (اختياري) سبيكة مدورة
علني (اختياري) ولوج
cURL PHP Node.js Python C# 
curl - الموقع - طلب POST "https://urlkai.com/api/campaign/add" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \
--data-raw '{
    "name": "حملة جديدة",
    "slug": "حملة جديدة",
    "عام": صحيح
}' 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/campaign/add" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "POST" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "حملة جديدة",
	    "slug": "حملة جديدة",
	    "عام": صحيح
	}',
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/add',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: JSON.stringify({
    "name": "حملة جديدة",
    "slug": "حملة جديدة",
    "عام": صحيح
}),
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/campaign/add"
الحمولة = {
    "name": "حملة جديدة",
    "slug": "حملة جديدة",
    "عام": صحيح
}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("POST"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/add");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{
    "name": "حملة جديدة",
    "slug": "حملة جديدة",
    "عام": صحيح
}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "المعرف": 3 ،
    "domain": "حملة جديدة"،
    "عام": صحيح,
    "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

يمكن تعيين رابط قصير لحملة باستخدام نقطة النهاية هذه. تتطلب نقطة النهاية معرف الحملة ومعرف الارتباط القصير.

cURL PHP Node.js Python C# 
curl - الموقع - طلب POST "https://urlkai.com/api/campaign/:campaignid/assign/:linkid" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/campaign/:campaignid/assign/:linkid" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "POST" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/campaign/:campaignid/assign/:linkid"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("POST"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/campaign/:campaignid/assign/:linkid");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "message": "تمت إضافة الرابط بنجاح إلى الحملة."
}
Actualizar campaña
PUT https://urlkai.com/api/campaign/:id/update

لتحديث حملة، تحتاج إلى إرسال بيانات صالحة في JSON عبر طلب PUT. يجب إرسال البيانات كنص أولي لطلبك كما هو موضح أدناه. يوضح المثال أدناه جميع المعلمات التي يمكنك إرسالها ولكن لست مطالبا بإرسال الكل (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
اسم (مطلوب) اسم الحملة
سبيكه (اختياري) سبيكة مدورة
علني (اختياري) ولوج
cURL PHP Node.js Python C# 
curl - الموقع - طلب PUT 'https://urlkai.com/api/campaign/:id/update' \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \
--data-raw '{
    "الاسم": "حملة تويتر",
    "slug": "حملة تويتر",
    "عام": صحيح
}' 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/campaign/:id/update" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "وضع" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "الاسم": "حملة تويتر",
	    "slug": "حملة تويتر",
	    "عام": صحيح
	}',
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'طريقة': 'وضع',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: JSON.stringify({
    "الاسم": "حملة تويتر",
    "slug": "حملة تويتر",
    "عام": صحيح
}),
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/campaign/:id/update"
الحمولة = {
    "الاسم": "حملة تويتر",
    "slug": "حملة تويتر",
    "عام": صحيح
}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("PUT"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/campaign/:id/update");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{
    "الاسم": "حملة تويتر",
    "slug": "حملة تويتر",
    "عام": صحيح
}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "المعرف": 3 ،
    "النطاق": "حملة تويتر"،
    "عام": صحيح,
    "rotator": "https:\/\/domain.com\/r\/twitter-campaign",
    "list": "https:\/\/domain.com\/u\/admin\/twitter-campaign-3"
}
حذف الحملة
DELETE https://urlkai.com/api/campaign/:id/delete

لحذف حملة، عليك إرسال طلب حذف.

cURL PHP Node.js Python C# 
curl --location --request delete 'https://urlkai.com/api/campaign/:id/delete' \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL => "https://urlkai.com/api/campaign/:id/delete" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "حذف" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'حذف',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/campaign/:id/delete"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/campaign/:id/delete");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "message": "تم حذف الحملة بنجاح."
}

Canales

قائمة القنوات
GET https://urlkai.com/api/channels?limit=2&page=1

للحصول على قنواتك عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
حد (اختياري) نتيجة بيانات لكل صفحة
صفحة (اختياري) طلب الصفحة الحالية
cURL PHP Node.js Python C# 
curl - الموقع - طلب الحصول على "https://urlkai.com/api/channels?limit=2&page=1" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/channels?limit=2&page=1" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "GET" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/channels?limit=2&page=1"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channels?limit=2&page=1");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "error": "0",
    "البيانات": {
        "النتيجة": 2 ،
        "perpage": 2 ،
        "الصفحة الحالية": 1,
        "الصفحة التالية": 1,
        "maxpage": 1 ،
        "القنوات": [
            {
                "المعرف": 1 ،
                "الاسم": "القناة 1",
                "description": "وصف القناة 1",
                "اللون": "#000000",
                "متميز": صحيح
            },
            {
                "المعرف": 2 ،
                "name": "القناة 2",
                "description": "وصف القناة 2",
                "اللون": "#FF0000",
                "متميز": خطأ
            }
        ]
    }
}
قائمة عناصر القناة
GET https://urlkai.com/api/channel/:id?limit=1&page=1

للحصول على عناصر في قنوات محددة عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
حد (اختياري) نتيجة بيانات لكل صفحة
صفحة (اختياري) طلب الصفحة الحالية
cURL PHP Node.js Python C# 
curl - الموقع - طلب الحصول على "https://urlkai.com/api/channel/:id?limit=1&page=1" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/channel/:id?limit=1&page=1" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "GET" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/channel/:id?limit=1&page=1"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/channel/:id?limit=1&page=1");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "error": "0",
    "البيانات": {
        "النتيجة": 2 ،
        "perpage": 2 ،
        "الصفحة الحالية": 1,
        "الصفحة التالية": 1,
        "maxpage": 1 ،
        "العناصر": [
            {
                "type": "links",
                "المعرف": 1 ،
                "title": "رابط العينة الخاص بي",
                "معاينة": "https:\/\/google.com",
                "link": "https:\/\/urlkai.com\/google",
                "التاريخ": "2022-05-12"
            },
            {
                "النوع": "السيرة الذاتية",
                "المعرف": 1 ،
                "title": "عينة السيرة الذاتية الخاصة بي",
                "معاينة": "https:\/\/urlkai.com\/mybio",
                "link": "https:\/\/urlkai.com\/mybio",
                "التاريخ": "2022-06-01"
            }
        ]
    }
}
Crear un canal
POST https://urlkai.com/api/channel/add

يمكن إضافة قناة باستخدام نقطة النهاية هذه.

ParámetroDescripción
اسم (مطلوب) اسم القناة
وصف (اختياري) وصف القناة
لون (اختياري) لون شارة القناة (HEX)
نجمه (اختياري) نجمة القناة أم لا (صواب أو خطأ)
cURL PHP Node.js Python C# 
curl - الموقع - طلب POST "https://urlkai.com/api/channel/add" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \
--data-raw '{
    "name": "قناة جديدة",
    "description": "قناتي الجديدة",
    "اللون": "#000000",
    "متميز": صحيح
}' 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/channel/add" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "POST" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "قناة جديدة",
	    "description": "قناتي الجديدة",
	    "اللون": "#000000",
	    "متميز": صحيح
	}',
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/add',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: JSON.stringify({
    "name": "قناة جديدة",
    "description": "قناتي الجديدة",
    "اللون": "#000000",
    "متميز": صحيح
}),
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/channel/add"
الحمولة = {
    "name": "قناة جديدة",
    "description": "قناتي الجديدة",
    "اللون": "#000000",
    "متميز": صحيح
}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("POST"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/add");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{
    "name": "قناة جديدة",
    "description": "قناتي الجديدة",
    "اللون": "#000000",
    "متميز": صحيح
}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "المعرف": 3 ،
    "name": "قناة جديدة",
    "description": "قناتي الجديدة",
    "اللون": "#000000",
    "متميز": صحيح
}
إسناد عنصر إلى قناة
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

يمكن تعيين عنصر إلى أي قناة عن طريق إرسال طلب يحتوي على معرف القناة ونوع العنصر (الروابط أو السيرة الذاتية أو qr) ومعرف العنصر.

ParámetroDescripción
channelid: (مطلوب) معرف القناة
:نوع (مطلوب) الروابط أو السيرة الذاتية أو QR
itemid: (مطلوب) معرف العنصر
cURL PHP Node.js Python C# 
curl - الموقع - طلب POST "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "POST" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("POST"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/channel/:channelid/assign/:type/:itemid");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "message": "تمت إضافة العنصر بنجاح إلى القناة."
}
Actualizar canal
PUT https://urlkai.com/api/channel/:id/update

لتحديث قناة، تحتاج إلى إرسال بيانات صالحة في JSON عبر طلب PUT. يجب إرسال البيانات كنص أولي لطلبك كما هو موضح أدناه. يوضح المثال أدناه جميع المعلمات التي يمكنك إرسالها ولكن لست مطالبا بإرسال الكل (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
اسم (اختياري) اسم القناة
وصف (اختياري) وصف القناة
لون (اختياري) لون شارة القناة (HEX)
نجمه (اختياري) نجمة القناة أم لا (صواب أو خطأ)
cURL PHP Node.js Python C# 
curl - الموقع - طلب PUT 'https://urlkai.com/api/channel/:id/update' \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \
--data-raw '{
    "الاسم": "Acme Corp",
    "description": "قناة لعناصر Acme Corp",
    "اللون": "#FFFFFF",
    "متميز": خطأ
}' 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/channel/:id/update" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "وضع" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "الاسم": "Acme Corp",
	    "description": "قناة لعناصر Acme Corp",
	    "اللون": "#FFFFFF",
	    "متميز": خطأ
	}',
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'طريقة': 'وضع',
    'url': 'https://urlkai.com/api/channel/:id/update',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: JSON.stringify({
    "الاسم": "Acme Corp",
    "description": "قناة لعناصر Acme Corp",
    "اللون": "#FFFFFF",
    "متميز": خطأ
}),
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/channel/:id/update"
الحمولة = {
    "الاسم": "Acme Corp",
    "description": "قناة لعناصر Acme Corp",
    "اللون": "#FFFFFF",
    "متميز": خطأ
}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("PUT"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/channel/:id/update");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{
    "الاسم": "Acme Corp",
    "description": "قناة لعناصر Acme Corp",
    "اللون": "#FFFFFF",
    "متميز": خطأ
}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "message": "تم تحديث القناة بنجاح".
}
حذف القناة
DELETE https://urlkai.com/api/channel/:id/delete

لحذف قناة، عليك إرسال طلب حذف. سيتم إلغاء تعيين جميع العناصر أيضا.

cURL PHP Node.js Python C# 
curl --location --request delete 'https://urlkai.com/api/channel/:id/delete' \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/channel/:id/delete" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "حذف" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'حذف',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/channel/:id/delete"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/channel/:id/delete");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "message": "تم حذف القناة بنجاح".
}

Cuenta

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

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

cURL PHP Node.js Python C# 
curl - الموقع - طلب الحصول على "https://urlkai.com/api/account" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/account" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "GET" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/account',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/account"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/account");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "البيانات": {
        "المعرف": 1 ،
        "البريد الإلكتروني": " [البريد الإلكتروني محمي] ",
        "اسم المستخدم": "sampleuser",
        "الصورة الرمزية": "https:\/\/domain.com\/content\/avatar.png",
        "status": "pro",
        "تنتهي الصلاحية": "2022-11-15 15:00:00",
        "مسجل": "2020-11-10 18:01:43"
    }
}
Actualizar cuenta
PUT https://urlkai.com/api/account/update

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

cURL PHP Node.js Python C# 
curl - الموقع - طلب PUT 'https://urlkai.com/api/account/update' \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \
--data-raw '{
    "البريد الإلكتروني": " [البريد الإلكتروني محمي] ",
    "password": كلمة مرور جديدة"
}' 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/account/update" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "وضع" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "البريد الإلكتروني": " [البريد الإلكتروني محمي] ",
	    "password": كلمة مرور جديدة"
	}',
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'طريقة': 'وضع',
    'url': 'https://urlkai.com/api/account/update',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: JSON.stringify({
    "البريد الإلكتروني": " [البريد الإلكتروني محمي] ",
    "password": كلمة مرور جديدة"
}),
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/account/update"
الحمولة = {
    "البريد الإلكتروني": " [البريد الإلكتروني محمي] ",
    "password": كلمة مرور جديدة"
}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("PUT"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/account/update");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{
    "البريد الإلكتروني": " [البريد الإلكتروني محمي] ",
    "password": كلمة مرور جديدة"
}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "message": "تم تحديث الحساب بنجاح."
}

Códigos QR

قائمة رموز QR
GET https://urlkai.com/api/qr?limit=2&page=1

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

ParámetroDescripción
حد (اختياري) نتيجة بيانات لكل صفحة
صفحة (اختياري) طلب الصفحة الحالية
cURL PHP Node.js Python C# 
curl - الموقع - طلب الحصول على "https://urlkai.com/api/qr?limit=2&page=1" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/qr?limit=2&page=1" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "GET" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/qr?limit=2&page=1"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr?limit=2&page=1");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "error": "0",
    "البيانات": {
        "النتيجة": 2 ،
        "perpage": 2 ،
        "الصفحة الحالية": 1,
        "الصفحة التالية": 1,
        "maxpage": 1 ،
        "qrs": [
            {
                "المعرف": 2 ،
                "link": "https:\/\/urlkai.com\/qr\/a2d5e",
                "عمليات المسح": 0 ،
                "الاسم": "Google",
                "التاريخ": "2020-11-10 18:01:43"
            },
            {
                "المعرف": 1 ،
                "link": "https:\/\/urlkai.com\/qr\/b9edfe",
                "عمليات المسح": 5 ،
                "name": "Google Canada",
                "التاريخ": "2020-11-10 18:00:25"
            }
        ]
    }
}
Obtenga un solo código QR
GET https://urlkai.com/api/qr/:id

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

cURL PHP Node.js Python C# 
curl - الموقع - طلب الحصول على "https://urlkai.com/api/qr/:id" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL => "https://urlkai.com/api/qr/:id",
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "GET" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/qr/:id',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/qr/:id"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/qr/:id");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "التفاصيل": {
        "المعرف": 1 ،
        "link": "https:\/\/urlkai.com\/qr\/b9edfe",
        "عمليات المسح": 5 ،
        "name": "Google Canada",
        "التاريخ": "2020-11-10 18:00:25"
    },
    "البيانات": {
        "النقرات": 1,
        "uniqueClicks": 1 ،
        "topCountries": {
            "غير معروف": "1"
        },
        "topReferrers": {
            "مباشر وبريد إلكتروني وغيرها": "1"
        },
        "topBrowsers": {
            "Chrome": "1"
        },
        "topOs": {
            "Windows 10": "1"
        },
        "socialCount": {
            "الفيسبوك": 0,
            "تويتر": 0,
            "إنستغرام": 0
        }
    }
}
Crear un código QR
POST https://urlkai.com/api/qr/add

لإنشاء رمز الاستجابة السريعة ، تحتاج إلى إرسال بيانات صالحة في JSON عبر طلب POST. يجب إرسال البيانات كنص أولي لطلبك كما هو موضح أدناه. يوضح المثال أدناه جميع المعلمات التي يمكنك إرسالها ولكن لست مطالبا بإرسال الكل (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
نوع (مطلوب) نص | VCARD | حلقة الوصل | البريد الإلكتروني | هاتف | الرسائل القصيرة | واي فاي
بيانات (مطلوب) البيانات المراد تضمينها داخل رمز الاستجابة السريعة. يمكن أن تكون البيانات سلسلة أو مصفوفة حسب النوع
خلفية (اختياري) لون RGB على سبيل المثال RGB (255,255,255)
المقدمه (اختياري) لون RGB على سبيل المثال RGB (0،0،0)
شعار (اختياري) المسار إلى الشعار إما png أو jpg
اسم (اختياري) اسم رمز الاستجابة السريعة
cURL PHP Node.js Python C# 
curl - الموقع - طلب POST "https://urlkai.com/api/qr/add" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \
--data-raw '{
    "النوع": "الرابط",
    "data": "https:\/\/google.com",
    "background": "RGB (255,255,255)",
    "المقدمة": "RGB (0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "الاسم": "واجهة برمجة تطبيقات رمز الاستجابة السريعة"
}' 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/qr/add" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "POST" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "النوع": "الرابط",
	    "data": "https:\/\/google.com",
	    "background": "RGB (255,255,255)",
	    "المقدمة": "RGB (0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png",
	    "الاسم": "واجهة برمجة تطبيقات رمز الاستجابة السريعة"
	}',
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/qr/add',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: JSON.stringify({
    "النوع": "الرابط",
    "data": "https:\/\/google.com",
    "background": "RGB (255,255,255)",
    "المقدمة": "RGB (0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "الاسم": "واجهة برمجة تطبيقات رمز الاستجابة السريعة"
}),
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/qr/add"
الحمولة = {
    "النوع": "الرابط",
    "البيانات": "https://google.com",
    "background": "RGB (255,255,255)",
    "المقدمة": "RGB (0,0,0)",
    "logo": "https://site.com/logo.png",
    "الاسم": "واجهة برمجة تطبيقات رمز الاستجابة السريعة"
}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("POST"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/qr/add");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{
    "النوع": "الرابط",
    "data": "https:\/\/google.com",
    "background": "RGB (255,255,255)",
    "المقدمة": "RGB (0,0,0)",
    "logo": "https:\/\/site.com\/logo.png",
    "الاسم": "واجهة برمجة تطبيقات رمز الاستجابة السريعة"
}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "المعرف": 3 ،
    "link": "https:\/\/urlkai.com\/qr\/a58f79"
}
تحديث رمز الاستجابة السريعة
PUT https://urlkai.com/api/qr/:id/update

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

ParámetroDescripción
بيانات (مطلوب) البيانات المراد تضمينها داخل رمز الاستجابة السريعة. يمكن أن تكون البيانات سلسلة أو مصفوفة حسب النوع
خلفية (اختياري) لون RGB على سبيل المثال RGB (255,255,255)
المقدمه (اختياري) لون RGB على سبيل المثال RGB (0،0،0)
شعار (اختياري) المسار إلى الشعار إما png أو jpg
cURL PHP Node.js Python C# 
curl - الموقع - طلب PUT 'https://urlkai.com/api/qr/:id/update' \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \
--data-raw '{
    "النوع": "الرابط",
    "data": "https:\/\/google.com",
    "background": "RGB (255,255,255)",
    "المقدمة": "RGB (0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}' 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/qr/:id/update" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "وضع" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "النوع": "الرابط",
	    "data": "https:\/\/google.com",
	    "background": "RGB (255,255,255)",
	    "المقدمة": "RGB (0,0,0)",
	    "logo": "https:\/\/site.com\/logo.png"
	}',
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'طريقة': 'وضع',
    'url': 'https://urlkai.com/api/qr/:id/update',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: JSON.stringify({
    "النوع": "الرابط",
    "data": "https:\/\/google.com",
    "background": "RGB (255,255,255)",
    "المقدمة": "RGB (0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}),
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/qr/:id/update"
الحمولة = {
    "النوع": "الرابط",
    "البيانات": "https://google.com",
    "background": "RGB (255,255,255)",
    "المقدمة": "RGB (0,0,0)",
    "logo": "https://site.com/logo.png"
}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("PUT"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/qr/:id/update");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{
    "النوع": "الرابط",
    "data": "https:\/\/google.com",
    "background": "RGB (255,255,255)",
    "المقدمة": "RGB (0,0,0)",
    "logo": "https:\/\/site.com\/logo.png"
}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "الرسالة": "تم تحديث QR بنجاح."
}
Eliminar un código QR
DELETE https://urlkai.com/api/qr/:id/delete

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

cURL PHP Node.js Python C# 
curl --location --request delete 'https://urlkai.com/api/qr/:id/delete' \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/qr/:id/delete" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "حذف" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'حذف',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/qr/:id/delete"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/qr/:id/delete");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "message": "تم حذف رمز الاستجابة السريعة بنجاح."
}

Dominios de marca

قائمة النطاقات ذات العلامات التجارية
GET https://urlkai.com/api/domains?limit=2&page=1

للحصول على المجالات ذات العلامات التجارية الخاصة بك عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
حد (اختياري) نتيجة بيانات لكل صفحة
صفحة (اختياري) طلب الصفحة الحالية
cURL PHP Node.js Python C# 
curl - الموقع - طلب الحصول على "https://urlkai.com/api/domains?limit=2&page=1" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/domains?limit=2&page=1" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "GET" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/domains?limit=2&page=1"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/domains?limit=2&page=1");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "error": "0",
    "البيانات": {
        "النتيجة": 2 ،
        "perpage": 2 ،
        "الصفحة الحالية": 1,
        "الصفحة التالية": 1,
        "maxpage": 1 ،
        "المجالات": [
            {
                "المعرف": 1 ،
                "المجال": "https:\/\/domain1.com",
                "redirectroot": "https:\/\/rootdomain.com",
                "redirect404": "https:\/\/rootdomain.com\/404"
            },
            {
                "المعرف": 2 ،
                "المجال": "https:\/\/domain2.com",
                "redirectroot": "https:\/\/rootdomain2.com",
                "redirect404": "https:\/\/rootdomain2.com\/404"
            }
        ]
    }
}
إنشاء نطاق مرتبط بعلامة تجارية
POST https://urlkai.com/api/domain/add

يمكن إضافة مجال باستخدام نقطة النهاية هذه. يرجى التأكد من توجيه النطاق بشكل صحيح إلى خادمنا.

ParámetroDescripción
المجال (مطلوب) النطاق المرتبط بعلامة تجارية بما في ذلك http أو https
redirectroot (اختياري) إعادة توجيه الجذر عندما يزور شخص ما نطاقك
إعادة التوجيه404 (اختياري) إعادة توجيه 404 المخصصة
cURL PHP Node.js Python C# 
curl - الموقع - طلب POST "https://urlkai.com/api/domain/add" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \
--data-raw '{
    "المجال": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}' 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/domain/add" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "POST" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "المجال": "https:\/\/domain1.com",
	    "redirectroot": "https:\/\/rootdomain.com",
	    "redirect404": "https:\/\/rootdomain.com\/404"
	}',
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/domain/add',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: JSON.stringify({
    "المجال": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}),
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/domain/add"
الحمولة = {
    "domain": "https://domain1.com",
    "redirectroot": "https://rootdomain.com",
    "redirect404": "https://rootdomain.com/404"
}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("POST"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/domain/add");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{
    "المجال": "https:\/\/domain1.com",
    "redirectroot": "https:\/\/rootdomain.com",
    "redirect404": "https:\/\/rootdomain.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "المعرف": 1
}
Actualizar dominio
PUT https://urlkai.com/api/domain/:id/update

لتحديث نطاق ذي علامة تجارية، تحتاج إلى إرسال بيانات صالحة في JSON عبر طلب PUT. يجب إرسال البيانات كنص أولي لطلبك كما هو موضح أدناه. يوضح المثال أدناه جميع المعلمات التي يمكنك إرسالها ولكن لست مطالبا بإرسال الكل (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
redirectroot (اختياري) إعادة توجيه الجذر عندما يزور شخص ما نطاقك
إعادة التوجيه404 (اختياري) إعادة توجيه 404 المخصصة
cURL PHP Node.js Python C# 
curl - الموقع - طلب PUT 'https://urlkai.com/api/domain/:id/update' \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \
--data-raw '{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}' 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/domain/:id/update" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "وضع" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "redirectroot": "https:\/\/rootdomain-new.com",
	    "redirect404": "https:\/\/rootdomain-new.com\/404"
	}',
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'طريقة': 'وضع',
    'url': 'https://urlkai.com/api/domain/:id/update',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: JSON.stringify({
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}),
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/domain/:id/update"
الحمولة = {
    "redirectroot": "https://rootdomain-new.com",
    "redirect404": "https://rootdomain-new.com/404"
}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("PUT"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/domain/:id/update");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{
    "redirectroot": "https:\/\/rootdomain-new.com",
    "redirect404": "https:\/\/rootdomain-new.com\/404"
}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "message": "تم تحديث النطاق بنجاح."
}
حذف المجال
DELETE https://urlkai.com/api/domain/:id/delete

لحذف نطاق، عليك إرسال طلب حذف.

cURL PHP Node.js Python C# 
curl --location --request delete 'https://urlkai.com/api/domain/:id/delete' \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/domain/:id/delete" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "حذف" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'حذف',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/domain/:id/delete"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/domain/:id/delete");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "message": "تم حذف النطاق بنجاح."
}

Enlaces

Files

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

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

ParámetroDescripción
اسم (optional) Search for a file by name
حد (اختياري) نتيجة بيانات لكل صفحة
صفحة (اختياري) طلب الصفحة الحالية
cURL PHP Node.js Python C# 
curl --location --request GET 'https://urlkai.com/api/files?limit=2&page=1' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \

$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
var request = require('request');
var options = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/files?limit=2&page=1',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
import requests
url = "https://urlkai.com/api/files?limit=2&page=1"
payload = {}
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("GET", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/files?limit=2&page=1");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Respuesta del servidor
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/XWQsB",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/ZcymO",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/MQoIu",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
Upload a file
POST https://urlkai.com/api/files/upload/:filename?name=My+File

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

ParámetroDescripción
اسم (optional) File name
تقليد (اختياري) الاسم المستعار المخصص بدلا من الاسم المستعار العشوائي.
المجال (اختياري) المجال المخصص
شعار (اختياري) حماية كلمة المرور
انتهاء (optional) Expiration for the download example 2021-09-28
maxdownloads (optional) Maximum number of downloads
cURL PHP Node.js Python C# 
curl --location --request POST 'https://urlkai.com/api/files/upload/:filename?name=My+File' \
--header 'Authorization: Bearer YOURAPIKEY' \
--header 'Content-Type: application/json' \
--data-raw '"BINARY DATA"'
$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;
var request = require('request');
var options = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/files/upload/:filename?name=My+File',
    'headers': {
        'Authorization': 'Bearer YOURAPIKEY',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify("BINARY DATA"),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
});
import requests
url = "https://urlkai.com/api/files/upload/:filename?name=My+File"
payload = "BINARY DATA"
headers = {
    'Authorization': 'Bearer YOURAPIKEY',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.text)

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/files/upload/:filename?name=My+File");
request.Headers.Add("Authorization", "Bearer YOURAPIKEY");
var content = new StringContent(""BINARY DATA"", System.Text.Encoding.UTF8, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Respuesta del servidor
{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/urlkai.com\/aSgNm"
}

Personalizar página de bienvenida

قائمة سبلاش مخصص
GET https://urlkai.com/api/splash?limit=2&page=1

للحصول على صفحات البداية المخصصة عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
حد (اختياري) نتيجة بيانات لكل صفحة
صفحة (اختياري) طلب الصفحة الحالية
cURL PHP Node.js Python C# 
curl - الموقع - طلب الحصول على "https://urlkai.com/api/splash?limit=2&page=1" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/splash?limit=2&page=1" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "GET" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/splash?limit=2&page=1"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/splash?limit=2&page=1");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "error": "0",
    "البيانات": {
        "النتيجة": 2 ،
        "perpage": 2 ،
        "الصفحة الحالية": 1,
        "الصفحة التالية": 1,
        "maxpage": 1 ،
        "سبلاش": [
            {
                "المعرف": 1 ،
                "الاسم": "المنتج 1 الترويجي",
                "التاريخ": "2020-11-10 18:00:00"
            },
            {
                "المعرف": 2 ،
                "الاسم": "المنتج 2 الترويجي",
                "التاريخ": "2020-11-10 18:10:00"
            }
        ]
    }
}

العنصورات

قائمة وحدات البكسل
GET https://urlkai.com/api/pixels?limit=2&page=1

للحصول على أكواد وحدات البكسل الخاصة بك عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
حد (اختياري) نتيجة بيانات لكل صفحة
صفحة (اختياري) طلب الصفحة الحالية
cURL PHP Node.js Python C# 
curl - الموقع - طلب الحصول على "https://urlkai.com/api/pixels?limit=2&page=1" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/pixels?limit=2&page=1" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "GET" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/pixels?limit=2&page=1"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/pixels?limit=2&page=1");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "error": "0",
    "البيانات": {
        "النتيجة": 2 ،
        "perpage": 2 ،
        "الصفحة الحالية": 1,
        "الصفحة التالية": 1,
        "maxpage": 1 ،
        "وحدات البكسل": [
            {
                "المعرف": 1 ،
                "النوع": "gtmpixel",
                "الاسم": "GTM Pixel",
                "الوسم": "GA-123456789",
                "التاريخ": "2020-11-10 18:00:00"
            },
            {
                "المعرف": 2 ،
                "type": "twitterpixel",
                "الاسم": "Twitter Pixel",
                "tag": "1234567",
                "التاريخ": "2020-11-10 18:10:00"
            }
        ]
    }
}
إنشاء بيكسل
POST https://urlkai.com/api/pixel/add

يمكن إنشاء بكسل باستخدام نقطة النهاية هذه. تحتاج إلى إرسال نوع البكسل والعلامة.

ParámetroDescripción
نوع (مطلوب) GTMPIXEL | جابيكسل | FBPIXEL | AdwordsPixel | لينكد إن بيكسل | تويتر بكسل | AdrollPixel | كورابيكسل | بينتيريست | بينغ | سناب شات | رديت | تيك توك
اسم (مطلوب) اسم مخصص للبكسل الخاص بك
يوم (مطلوب) علامة البكسل
cURL PHP Node.js Python C# 
curl - الموقع - طلب POST "https://urlkai.com/api/pixel/add" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \
--data-raw '{
    "النوع": "gtmpixel",
    "name": "GTM الخاص بي",
    "العلامة": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/pixel/add" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "POST" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "النوع": "gtmpixel",
	    "name": "GTM الخاص بي",
	    "العلامة": "GTM-ABCDE"
	}',
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'POST',
    'url': 'https://urlkai.com/api/pixel/add',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: JSON.stringify({
    "النوع": "gtmpixel",
    "name": "GTM الخاص بي",
    "العلامة": "GTM-ABCDE"
}),
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/pixel/add"
الحمولة = {
    "النوع": "gtmpixel",
    "name": "GTM الخاص بي",
    "العلامة": "GTM-ABCDE"
}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("POST"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Post, "https://urlkai.com/api/pixel/add");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{
    "النوع": "gtmpixel",
    "name": "GTM الخاص بي",
    "العلامة": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "المعرف": 1
}
Actualizar píxel
PUT https://urlkai.com/api/pixel/:id/update

لتحديث بكسل ، تحتاج إلى إرسال بيانات صالحة في JSON عبر طلب PUT. يجب إرسال البيانات كنص أولي لطلبك كما هو موضح أدناه. يوضح المثال أدناه جميع المعلمات التي يمكنك إرسالها ولكن لست مطالبا بإرسال الكل (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
اسم (اختياري) اسم مخصص للبكسل الخاص بك
يوم (مطلوب) علامة البكسل
cURL PHP Node.js Python C# 
curl - الموقع - طلب PUT 'https://urlkai.com/api/pixel/:id/update' \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \
--data-raw '{
    "name": "GTM الخاص بي",
    "العلامة": "GTM-ABCDE"
}' 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL => "https://urlkai.com/api/pixel/:id/update",
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "وضع" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    CURLOPT_POSTFIELDS => 
        '{
	    "name": "GTM الخاص بي",
	    "العلامة": "GTM-ABCDE"
	}',
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'طريقة': 'وضع',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    الجسم: JSON.stringify({
    "name": "GTM الخاص بي",
    "العلامة": "GTM-ABCDE"
}),
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/pixel/:id/update"
الحمولة = {
    "name": "GTM الخاص بي",
    "العلامة": "GTM-ABCDE"
}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("PUT"، عنوان url، headers=headers، json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Put, "https://urlkai.com/api/pixel/:id/update");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{
    "name": "GTM الخاص بي",
    "العلامة": "GTM-ABCDE"
}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "message": "تم تحديث Pixel بنجاح".
}
حذف البكسل
DELETE https://urlkai.com/api/pixel/:id/delete

لحذف بكسل، تحتاج إلى إرسال طلب حذف.

cURL PHP Node.js Python C# 
curl --location --request delete 'https://urlkai.com/api/pixel/:id/delete' \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/pixel/:id/delete" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "حذف" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'حذف',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/pixel/:id/delete"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("DELETE", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Delete, "https://urlkai.com/api/pixel/:id/delete");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "خطأ": 0,
    "message": "تم حذف Pixel بنجاح".
}

Superposiciones de CTA

قائمة تراكبات CTA
GET https://urlkai.com/api/overlay?limit=2&page=1

للحصول على تراكبات الحث على اتخاذ إجراء عبر واجهة برمجة التطبيقات، يمكنك استخدام نقطة النهاية هذه. يمكنك أيضا تصفية البيانات (انظر الجدول لمزيد من المعلومات).

ParámetroDescripción
حد (اختياري) نتيجة بيانات لكل صفحة
صفحة (اختياري) طلب الصفحة الحالية
cURL PHP Node.js Python C# 
curl - الموقع - طلب الحصول على "https://urlkai.com/api/overlay?limit=2&page=1" \
--header 'التفويض: حامل YOURAPIKEY' \
--header "نوع المحتوى: التطبيق / json" \ 
$curl = curl_init();

curl_setopt_array ($curl ، صفيف (
    CURLOPT_URL = > "https://urlkai.com/api/overlay?limit=2&page=1" ،
    CURLOPT_RETURNTRANSFER = > صحيح ،
    CURLOPT_MAXREDIRS = > 2 ،
    CURLOPT_TIMEOUT = > 10 ،
    CURLOPT_FOLLOWLOCATION = > صحيح ،
    CURLOPT_CUSTOMREQUEST = > "GET" ،
    CURLOPT_HTTPHEADER => [
        "التفويض: حاملها يورابيكي"،
        "نوع المحتوى: التطبيق / json" ،
    ],
    
));

$response = curl_exec ($curl) ؛

curl_close($curl)؛
صدى $response ؛ 
var request = require('request');
خيارات var = {
    'method': 'GET',
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1',
    'headers': {
        'التفويض': 'حامله يورابيكي',
        "نوع المحتوى": "تطبيق/json"
    },
    
};
request(خيارات، دالة (خطأ، استجابة) {
    إذا (خطأ) رمي خطأ (خطأ) جديد؛
    console.log (استجابة للجسم) ؛
}); 
طلبات الاستيراد
url = "https://urlkai.com/api/overlay?limit=2&page=1"
الحمولة = {}
الرؤوس = {
    'التفويض': 'حامله يورابيكي',
    "نوع المحتوى": "تطبيق/json"
}
الاستجابة = requests.request("GET", url, headers=headers, json=payload)
print(response.text) 
var client = HttpClient() جديد;
var request = جديد HttpRequestMessage(HttpMethod.Get, "https://urlkai.com/api/overlay?limit=2&page=1");
طلب. Headers.Add("التفويض"، "حامله YOURAPIKEY")؛
var content = new StringContent("{}", System.Text.Encoding.UTF8, "application/json");
طلب. المحتوى = المحتوى.
استجابة var = انتظار العميل. SendAsync (طلب) ؛
استجابه. EnsureSuccessStatusCode();
Console.WriteLine(انتظر الاستجابة. Content.ReadAsStringAsync());
Respuesta del servidor
{
    "error": "0",
    "البيانات": {
        "النتيجة": 2 ،
        "perpage": 2 ،
        "الصفحة الحالية": 1,
        "الصفحة التالية": 1,
        "maxpage": 1 ،
        "CTA": [
            {
                "المعرف": 1 ،
                "type": "message",
                "الاسم": "المنتج 1 الترويجي",
                "التاريخ": "2020-11-10 18:00:00"
            },
            {
                "المعرف": 2 ،
                "النوع": "جهة الاتصال",
                "الاسم": "صفحة الاتصال",
                "التاريخ": "2020-11-10 18:10:00"
            }
        ]
    }
}