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 --location --request POST 'https://urlkai.com/api/account' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();
curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/account”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “POST”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
));

$response = curl_exec($curl); 
var 請求 = require('request');
var 選項 = {
    'method': '發佈',
    'url': 'https://urlkai.com/api/account',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    body: ''
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/account”
有效載荷 = {}
標頭 = {
  '授權': 'Bearer YOURAPIKEY',
  '內容類型': 'application/json'
}
回應 = 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/account”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。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

要通過 API 獲取您的促銷活動,您可以使用此終端節點。您還可以篩選數據(有關更多資訊,請參閱表格)。

ParámetroDescripción
限制 (選擇)每頁數據結果
(選擇)當前頁面請求
curl --location --request GET 'https://urlkai.com/api/campaigns?limit=2&page=1' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/campaigns?limit=2&page=1”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “GET”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': 'GET', @方法
    'url': 'https://urlkai.com/api/campaigns?limit=2&page=1',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/campaigns?limit=2&page=1”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/campaigns?limit=2&page=1”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “error”: “0”, /錯誤“: ”0“,
    “數據”: {
        “result”: 2,
        “perpage”: 2,
        “currentpage”: 1,
        “nextpage”: 1,
        “maxpage”: 1,
        “campaigns”: [
            {
                “id”: 1,
                “name”: “示例營銷活動”,
                “public”: false,
                “rotator”: false,
                “list”: “https:\/\/domain.com\/u\/admin\/list-1”
            },
            {
                “id”:2、
                “domain”: “Facebook 活動”,
                “public”: true,
                “rotator”: “https:\/\/domain.com\/r\/test”, @旋轉器“,
                “清單”: “https:\/\/domain.com\/u\/admin\/test-2”
            }
        ]
    }
} 
Crear una campaña
POST https://urlkai.com/api/campaign/add

可以使用此終端節點添加活動。

ParámetroDescripción
名字 (選擇)活動名稱
鼻涕蟲 (選擇)Rotator Slug
公共 (選擇)訪問
curl --location --request POST 'https://urlkai.com/api/campaign/add' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \
--data-raw '{
    “name”: “新廣告系列”,
    “slug”: “新戰役”,
    “public”: true
}' 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/campaign/add”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “POST”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    “name”: “新廣告系列”,
	    “slug”: “新戰役”,
	    “public”: true
	}',
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '發佈',
    'url': 'https://urlkai.com/api/campaign/add',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    正文:JSON.stringify({
    “name”: “新廣告系列”,
    “slug”: “新戰役”,
    “public”: true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/campaign/add”
有效載荷 = {
    “name”: “新廣告系列”,
    “slug”: “新戰役”,
    “public”: true
}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/campaign/add”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{
    “name”: “新廣告系列”,
    “slug”: “新戰役”,
    “public”: true
}“, System.Text.Encoding.UTF8, ”應用程式/json“);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “id”: 3,
    “domain”: “新廣告系列”,
    “public”: true,
    “輪換器”: “https:\/\/domain.com\/r\/new-campaign”,
    “list”: “https:\/\/domain.com\/u\/admin\/new-campaign-3”
} 
POST https://urlkai.com/api/campaign/:campaignid/assign/:linkid

可以使用此終端節點將短連結分配給營銷活動。終端節點需要活動ID和短連結ID。

curl --location --request POST 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/campaign/:campaignid/assign/:linkid”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “POST”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '發佈',
    'url': 'https://urlkai.com/api/campaign/:campaignid/assign/:linkid',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/campaign/:campaignid/assign/:linkid”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/campaign/:campaignid/assign/:linkid”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “message”: “已成功將連結添加到營銷活動。”
} 
Actualizar campaña
PUT https://urlkai.com/api/campaign/:id/update

要更新活動,您需要通過 PUT 請求以 JSON 格式發送有效數據。數據必須作為請求的原始正文發送,如下所示。下面的示例顯示了您可以發送的所有參數,但您不需要發送所有參數(有關更多資訊,請參閱表格)。

ParámetroDescripción
名字 (必填)活動名稱
鼻涕蟲 (選擇)Rotator Slug
公共 (選擇)訪問
curl --location --request PUT 'https://urlkai.com/api/campaign/:id/update' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \
--data-raw '{
    “name”: “Twitter 活動”,
    “slug”: “推特活動”,
    “public”: true
}' 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/campaign/:id/update”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “PUT”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    “name”: “Twitter 活動”,
	    “slug”: “推特活動”,
	    “public”: true
	}',
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '放',
    'url': 'https://urlkai.com/api/campaign/:id/update',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    正文:JSON.stringify({
    “name”: “Twitter 活動”,
    “slug”: “推特活動”,
    “public”: true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/campaign/:id/update”
有效載荷 = {
    “name”: “Twitter 活動”,
    “slug”: “推特活動”,
    “public”: true
}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
response = requests.request(“PUT”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var 請求 = new HttpRequestMessage(HttpMethod.Put, “https://urlkai.com/api/campaign/:id/update”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{
    “name”: “Twitter 活動”,
    “slug”: “推特活動”,
    “public”: true
}“, System.Text.Encoding.UTF8, ”應用程式/json“);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “id”: 3,
    “domain”: “Twitter 活動”,
    “public”: true,
    “rotator”: “https:\/\/domain.com\/r\/twitter-campaign”,
    “list”: “https:\/\/domain.com\/u\/admin\/twitter-campaign-3”
} 
刪除活動
DELETE https://urlkai.com/api/campaign/:id/delete

要刪除活動,您需要發送 DELETE 請求。

curl --location --request 刪除 'https://urlkai.com/api/campaign/:id/delete' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/campaign/:id/delete”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “刪除”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '刪除',
    'url': 'https://urlkai.com/api/campaign/:id/delete',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/campaign/:id/delete”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = requests.request(“DELETE”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var 請求 = new HttpRequestMessage(HttpMethod.Delete, “https://urlkai.com/api/campaign/:id/delete”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “message”: “已成功刪除促銷活動。”
} 

Canales

列出頻道
GET https://urlkai.com/api/channels?limit=2&page=1

要通過 API 獲取管道,您可以使用此終端節點。您還可以篩選數據(有關更多資訊,請參閱表格)。

ParámetroDescripción
限制 (選擇)每頁數據結果
(選擇)當前頁面請求
curl --location --request GET 'https://urlkai.com/api/channels?limit=2&page=1' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/channels?limit=2&page=1”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “GET”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': 'GET', @方法
    'url': 'https://urlkai.com/api/channels?limit=2&page=1',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/channels?limit=2&page=1”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/channels?limit=2&page=1”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “error”: “0”, /錯誤“: ”0“,
    “數據”: {
        “result”: 2,
        “perpage”: 2,
        “currentpage”: 1,
        “nextpage”: 1,
        “maxpage”: 1,
        “頻道”:[
            {
                “id”: 1,
                “name”: “通道 1”, /
                “description”: 頻道 1 的描述“,
                “color”: “#000000”, /顏色
                “starred”: true
            },
            {
                “id”:2、
                “name”: “通道 2”, /
                “description”: 頻道 2 的描述“,
                “color”: “#FF0000”,
                “starred”: false
            }
        ]
    }
} 
列出頻道項
GET https://urlkai.com/api/channel/:id?limit=1&page=1

要通過 API 獲取選定管道中的專案,您可以使用此端點。您還可以篩選數據(有關更多資訊,請參閱表格)。

ParámetroDescripción
限制 (選擇)每頁數據結果
(選擇)當前頁面請求
curl --location --request GET 'https://urlkai.com/api/channel/:id?limit=1&page=1' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/channel/:id?limit=1&page=1”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “GET”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': 'GET', @方法
    'url': 'https://urlkai.com/api/channel/:id?limit=1&page=1',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/channel/:id?limit=1&page=1”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = requests.request(“GET”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var 請求 = new 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 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “error”: “0”, /錯誤“: ”0“,
    “數據”: {
        “result”: 2,
        “perpage”: 2,
        “currentpage”: 1,
        “nextpage”: 1,
        “maxpage”: 1,
        “items”: [
            {
                “type”: “連結”,
                “id”: 1,
                “title”: “我的樣本連結”,
                “preview”: “https:\/\/google.com”, //
                “link”: “https:\/\/urlkai.com\/google”, //google“,
                “date”: “2022-05-12”
            },
            {
                “type”: “生物”,
                “id”: 1,
                “title”: “我的樣本簡歷”,
                “preview”: “https:\/\/urlkai.com\/mybio”, //mybio
                “link”: “https:\/\/urlkai.com\/mybio”, /連結
                “date”: “2022-06-01”
            }
        ]
    }
} 
Crear un canal
POST https://urlkai.com/api/channel/add

可以使用此終端節點添加通道。

ParámetroDescripción
名字 (必填)頻道名稱
描述 (選擇)頻道描述
顏色 (選擇)通道徽章顏色 (HEX)
主演 (選擇)是否為頻道加星標(true 或 false)
curl --location --request POST 'https://urlkai.com/api/channel/add' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \
--data-raw '{
    “name”: “新頻道”,
    “description”: “我的新頻道”,
    “color”: “#000000”, /顏色
    “starred”: true
}' 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/channel/add”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “POST”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    “name”: “新頻道”,
	    “description”: “我的新頻道”,
	    “color”: “#000000”, /顏色
	    “starred”: true
	}',
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '發佈',
    'url': 'https://urlkai.com/api/channel/add',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    正文:JSON.stringify({
    “name”: “新頻道”,
    “description”: “我的新頻道”,
    “color”: “#000000”, /顏色
    “starred”: true
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/channel/add”
有效載荷 = {
    “name”: “新頻道”,
    “description”: “我的新頻道”,
    “color”: “#000000”, /顏色
    “starred”: true
}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/channel/add”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{
    “name”: “新頻道”,
    “description”: “我的新頻道”,
    “color”: “#000000”, /顏色
    “starred”: true
}“, System.Text.Encoding.UTF8, ”應用程式/json“);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “id”: 3,
    “name”: “新頻道”,
    “description”: “我的新頻道”,
    “color”: “#000000”, /顏色
    “starred”: true
} 
將專案分配給管道
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

通過發送包含頻道 ID、商品類型(連結、生物或 qr)和商品 ID 的請求,可以將商品分配給任何管道。

ParámetroDescripción
:channelid (必填)頻道ID
:類型 (必需)鏈接或個人簡介或二維碼
:itemid (必填)商品ID
curl --location --request POST 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/channel/:channelid/assign/:type/:itemid”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “POST”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '發佈',
    'url': 'https://urlkai.com/api/channel/:channelid/assign/:type/:itemid',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/channel/:channelid/assign/:type/:itemid”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/channel/:channelid/assign/:type/:itemid”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “message”: “專案已成功添加到頻道。”
} 
Actualizar canal
PUT https://urlkai.com/api/channel/:id/update

要更新通道,您需要通過 PUT 請求以 JSON 格式發送有效數據。數據必須作為請求的原始正文發送,如下所示。下面的示例顯示了您可以發送的所有參數,但您不需要發送所有參數(有關更多資訊,請參閱表格)。

ParámetroDescripción
名字 (選擇)頻道名稱
描述 (選擇)頻道描述
顏色 (選擇)通道徽章顏色 (HEX)
主演 (選擇)是否為頻道加星標(true 或 false)
curl --location --request PUT 'https://urlkai.com/api/channel/:id/update' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \
--data-raw '{
    “name”: “Acme Corp”, @名稱
    “description”: “Acme Corp 的商品頻道”,
    “color”: “#FFFFFF”,
    “starred”: false
}' 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/channel/:id/update”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “PUT”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    “name”: “Acme Corp”, @名稱
	    “description”: “Acme Corp 的商品頻道”,
	    “color”: “#FFFFFF”,
	    “starred”: false
	}',
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '放',
    'url': 'https://urlkai.com/api/channel/:id/update',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    正文:JSON.stringify({
    “name”: “Acme Corp”, @名稱
    “description”: “Acme Corp 的商品頻道”,
    “color”: “#FFFFFF”,
    “starred”: false
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/channel/:id/update”
有效載荷 = {
    “name”: “Acme Corp”, @名稱
    “description”: “Acme Corp 的商品頻道”,
    “color”: “#FFFFFF”,
    “starred”: false
}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
response = requests.request(“PUT”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, “https://urlkai.com/api/channel/:id/update”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{
    “name”: “Acme Corp”, @名稱
    “description”: “Acme Corp 的商品頻道”,
    “color”: “#FFFFFF”,
    “starred”: false
}“, System.Text.Encoding.UTF8, ”應用程式/json“);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “message”: 頻道已成功更新。
} 
刪除頻道
DELETE https://urlkai.com/api/channel/:id/delete

要刪除頻道,您需要發送 DELETE 請求。所有專案也將被取消分配。

curl --location --request 刪除 'https://urlkai.com/api/channel/:id/delete' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/channel/:id/delete”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “刪除”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '刪除',
    'url': 'https://urlkai.com/api/channel/:id/delete',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/channel/:id/delete”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = requests.request(“DELETE”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, “https://urlkai.com/api/channel/:id/delete”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。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 --location --request GET 'https://urlkai.com/api/account' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/account”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “GET”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': 'GET', @方法
    'url': 'https://urlkai.com/api/account',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/account”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/account”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “數據”: {
        “id”: 1,
        “電子郵件”: ” [電子郵件保護] ",
        “使用者名”: “sampleuser”,
        “頭像”: “https:\/\/domain.com\/content\/avatar.png”,
        “status”: “pro”, @狀態
        “expires”: “2022-11-15 15:00:00”, @過期
        “registered”: “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 --location --request PUT 'https://urlkai.com/api/account/update' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \
--data-raw '{
    “電子郵件”: ” [電子郵件保護] ",
    “password”: “newpassword”
}' 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/account/update”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “PUT”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    “電子郵件”: ” [電子郵件保護] ",
	    “password”: “newpassword”
	}',
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '放',
    'url': 'https://urlkai.com/api/account/update',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    正文:JSON.stringify({
    “電子郵件”: ” [電子郵件保護] ",
    “password”: “newpassword”
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/account/update”
有效載荷 = {
    “電子郵件”: ” [電子郵件保護] ",
    “password”: “newpassword”
}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
response = requests.request(“PUT”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var 請求 = new HttpRequestMessage(HttpMethod.Put, “https://urlkai.com/api/account/update”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{
    “電子郵件”: ” [電子郵件保護] ",
    “password”: “newpassword”
}“, System.Text.Encoding.UTF8, ”應用程式/json“);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “message”: “帳戶已成功更新。”
} 

Códigos 二維碼

列出二維碼
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 --location --request GET 'https://urlkai.com/api/qr?limit=2&page=1' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/qr?limit=2&page=1”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “GET”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': 'GET', @方法
    'url': 'https://urlkai.com/api/qr?limit=2&page=1',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/qr?limit=2&page=1”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = requests.request(“GET”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var 請求 = new 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 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “error”: “0”, /錯誤“: ”0“,
    “數據”: {
        “result”: 2,
        “perpage”: 2,
        “currentpage”: 1,
        “nextpage”: 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 加拿大”,
                “date”: “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 --location --request GET 'https://urlkai.com/api/qr/:id' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/qr/:id”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “GET”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': 'GET', @方法
    'url': 'https://urlkai.com/api/qr/:id',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/qr/:id”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/qr/:id”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “詳細資訊”: {
        “id”: 1,
        “link”: “https:\/\/urlkai.com\/qr\/b9edfe”,
        “scans”:5、
        “name”: “Google 加拿大”,
        “date”: “2020-11-10 18:00:25”
    },
    “數據”: {
        “clicks”: 1,
        “uniqueClicks”: 1,
        “topCountries”: {
            “未知”: “1”
        },
        “topReferrers”:{
            “Direct, email and other”: “1”
        },
        “topBrowsers”:{
            “Chrome”: “1”
        },
        “topOs”: {
            “Windows 10”: “1”
        },
        “socialCount”: {
            “facebook”:0、
            “twitter”:0、
            “Instagram”:0
        }
    }
} 
Crear un código QR
POST https://urlkai.com/api/qr/add

要創建 QR 碼,您需要通過 POST 請求以 JSON 格式發送有效數據。數據必須作為請求的原始正文發送,如下所示。下面的示例顯示了您可以發送的所有參數,但您不需要發送所有參數(有關更多資訊,請參閱表格)。

ParámetroDescripción
類型 (必填) text |電子名片 |連結 |電子郵件 |電話 |短信 |無線網路
數據 (必填)要嵌入二維碼中的數據。數據可以是字串或陣列,具體取決於類型
背景 (選擇)RGB 顏色,例如 rgb(255,255,255)
前景 (選擇)RGB 顏色,例如 rgb(0,0,0)
商標 (選擇)徽標的路徑 png 或 jpg
名字 (選擇)二維碼名稱
curl --location --request POST 'https://urlkai.com/api/qr/add' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \
--data-raw '{
    “type”: “連結”,
    “data”: “https:\/\/google.com”, ///
    “background”: “rgb(255,255,255)”, /
    “foreground”: “rgb(0,0,0)”, /
    “徽標”: “https:\/\/site.com\/logo.png”,
    “name”: “二維碼 API”
}' 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/qr/add”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “POST”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    “type”: “連結”,
	    “data”: “https:\/\/google.com”, ///
	    “background”: “rgb(255,255,255)”, /
	    “foreground”: “rgb(0,0,0)”, /
	    “徽標”: “https:\/\/site.com\/logo.png”,
	    “name”: “二維碼 API”
	}',
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '發佈',
    'url': 'https://urlkai.com/api/qr/add',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    正文:JSON.stringify({
    “type”: “連結”,
    “data”: “https:\/\/google.com”, ///
    “background”: “rgb(255,255,255)”, /
    “foreground”: “rgb(0,0,0)”, /
    “徽標”: “https:\/\/site.com\/logo.png”,
    “name”: “二維碼 API”
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/qr/add”
有效載荷 = {
    “type”: “連結”,
    “data”: “https://google.com”, /數據
    “background”: “rgb(255,255,255)”, /
    “foreground”: “rgb(0,0,0)”, /
    “logo”: “https://site.com/logo.png”,
    “name”: “二維碼 API”
}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/qr/add”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{
    “type”: “連結”,
    “data”: “https:\/\/google.com”, ///
    “background”: “rgb(255,255,255)”, /
    “foreground”: “rgb(0,0,0)”, /
    “徽標”: “https:\/\/site.com\/logo.png”,
    “name”: “二維碼 API”
}“, System.Text.Encoding.UTF8, ”應用程式/json“);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “id”: 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 --location --request PUT 'https://urlkai.com/api/qr/:id/update' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \
--data-raw '{
    “type”: “連結”,
    “data”: “https:\/\/google.com”, ///
    “background”: “rgb(255,255,255)”, /
    “foreground”: “rgb(0,0,0)”, /
    “徽標”: “https:\/\/site.com\/logo.png”
}' 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/qr/:id/update”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “PUT”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    “type”: “連結”,
	    “data”: “https:\/\/google.com”, ///
	    “background”: “rgb(255,255,255)”, /
	    “foreground”: “rgb(0,0,0)”, /
	    “徽標”: “https:\/\/site.com\/logo.png”
	}',
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '放',
    'url': 'https://urlkai.com/api/qr/:id/update',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    正文:JSON.stringify({
    “type”: “連結”,
    “data”: “https:\/\/google.com”, ///
    “background”: “rgb(255,255,255)”, /
    “foreground”: “rgb(0,0,0)”, /
    “徽標”: “https:\/\/site.com\/logo.png”
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/qr/:id/update”
有效載荷 = {
    “type”: “連結”,
    “data”: “https://google.com”, /數據
    “background”: “rgb(255,255,255)”, /
    “foreground”: “rgb(0,0,0)”, /
    “logo”: “https://site.com/logo.png”
}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
response = requests.request(“PUT”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var 請求 = new HttpRequestMessage(HttpMethod.Put, “https://urlkai.com/api/qr/:id/update”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{
    “type”: “連結”,
    “data”: “https:\/\/google.com”, ///
    “background”: “rgb(255,255,255)”, /
    “foreground”: “rgb(0,0,0)”, /
    “徽標”: “https:\/\/site.com\/logo.png”
}“, System.Text.Encoding.UTF8, ”應用程式/json“);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “message”: “二維碼已成功更新。”
} 
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 --location --request DELETE 'https://urlkai.com/api/qr/:id/delete' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/qr/:id/delete”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “刪除”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '刪除',
    'url': 'https://urlkai.com/api/qr/:id/delete',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/qr/:id/delete”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = requests.request(“DELETE”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var 請求 = new HttpRequestMessage(HttpMethod.Delete, “https://urlkai.com/api/qr/:id/delete”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “message”: “已成功刪除 QR 碼。”
} 

Dominios de marca

列出品牌域
GET https://urlkai.com/api/domains?limit=2&page=1

要通過 API 獲取您的品牌域,您可以使用此終端節點。您還可以篩選數據(有關更多資訊,請參閱表格)。

ParámetroDescripción
限制 (選擇)每頁數據結果
(選擇)當前頁面請求
curl --location --request GET 'https://urlkai.com/api/domains?limit=2&page=1' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/domains?limit=2&page=1”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “GET”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': 'GET', @方法
    'url': 'https://urlkai.com/api/domains?limit=2&page=1',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/domains?limit=2&page=1”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = requests.request(“GET”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var 請求 = new 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 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “error”: “0”, /錯誤“: ”0“,
    “數據”: {
        “result”: 2,
        “perpage”: 2,
        “currentpage”: 1,
        “nextpage”: 1,
        “maxpage”: 1,
        “domains”: [
            {
                “id”: 1,
                “domain”: “https:\/\/domain1.com”, // ( 2000) 域
                “redirectroot”: “https:\/\/rootdomain.com”, /
                “redirect404”: “https:\/\/rootdomain.com\/404”
            },
            {
                “id”: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
重定向根 (選擇)當有人訪問您的域時進行根重定向
重定向404 (選擇)自定義 404 重定向
curl --location --request POST 'https://urlkai.com/api/domain/add' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \
--data-raw '{
    “domain”: “https:\/\/domain1.com”, // ( 2000) 域
    “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 => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “POST”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    “domain”: “https:\/\/domain1.com”, // ( 2000) 域
	    “redirectroot”: “https:\/\/rootdomain.com”, /
	    “redirect404”: “https:\/\/rootdomain.com\/404”
	}',
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '發佈',
    'url': 'https://urlkai.com/api/domain/add',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    正文:JSON.stringify({
    “domain”: “https:\/\/domain1.com”, // ( 2000) 域
    “redirectroot”: “https:\/\/rootdomain.com”, /
    “redirect404”: “https:\/\/rootdomain.com\/404”
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/domain/add”
有效載荷 = {
    “domain”: “https://domain1.com”, @域“: ”“,
    “redirectroot”: “https://rootdomain.com”, //
    “redirect404”: “https://rootdomain.com/404”
}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/domain/add”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{
    “domain”: “https:\/\/domain1.com”, // ( 2000) 域
    “redirectroot”: “https:\/\/rootdomain.com”, /
    “redirect404”: “https:\/\/rootdomain.com\/404”
}“, System.Text.Encoding.UTF8, ”應用程式/json“);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “id”:1
} 
Actualizar dominio
PUT https://urlkai.com/api/domain/:id/update

要更新品牌域,您需要通過 PUT 請求以 JSON 格式發送有效數據。數據必須作為請求的原始正文發送,如下所示。下面的示例顯示了您可以發送的所有參數,但您不需要發送所有參數(有關更多資訊,請參閱表格)。

ParámetroDescripción
重定向根 (選擇)當有人訪問您的域時進行根重定向
重定向404 (選擇)自定義 404 重定向
curl --location --request PUT 'https://urlkai.com/api/domain/:id/update' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/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 => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “PUT”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    “redirectroot”: “https:\/\/rootdomain-new.com”, ///
	    “redirect404”: “https:\/\/rootdomain-new.com\/404”
	}',
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '放',
    'url': 'https://urlkai.com/api/domain/:id/update',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    正文:JSON.stringify({
    “redirectroot”: “https:\/\/rootdomain-new.com”, ///
    “redirect404”: “https:\/\/rootdomain-new.com\/404”
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/domain/:id/update”
有效載荷 = {
    “redirectroot”: “https://rootdomain-new.com”, //
    “redirect404”: “https://rootdomain-new.com/404”
}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
response = requests.request(“PUT”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var 請求 = new 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, ”應用程式/json“);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “message”: “域已成功更新。”
} 
刪除域
DELETE https://urlkai.com/api/domain/:id/delete

要刪除域,您需要發送 DELETE 請求。

curl --location --request 刪除 'https://urlkai.com/api/domain/:id/delete' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/domain/:id/delete”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “刪除”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '刪除',
    'url': 'https://urlkai.com/api/domain/:id/delete',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/domain/:id/delete”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = requests.request(“DELETE”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var 請求 = new HttpRequestMessage(HttpMethod.Delete, “https://urlkai.com/api/domain/:id/delete”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “message”: “已成功刪除域。”
} 

Enlaces


列出檔
GET https://urlkai.com/api/files?limit=2&page=1

獲取您的所有檔。您還可以按名稱搜索。

ParámetroDescripción
名字 (選擇)按名稱搜索檔
限制 (選擇)每頁數據結果
(選擇)當前頁面請求
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\/tJipJ",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/IIhCH",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/ESXjI",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
上傳檔
POST https://urlkai.com/api/files/upload/:filename?name=My+File

通過將二進位數據作為post正文發送來上傳檔。您需要發送包含 extensions 而不是 url 中的 :filename 的檔名(例如 brandkit.zip)。您可以通過發送以下參數來設置選項。

ParámetroDescripción
名字 (選擇)檔名
習慣 (選擇)自定義別名而不是隨機別名。
(選擇)自訂域
密碼 (選擇)密碼保護
滿期 (選擇)下載示例的過期時間 2021-09-28
最大下載 (選擇)最大下載次數
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\/IKIzG"
}

Personalizar página de bienvenida

列出自定義啟動畫面
GET https://urlkai.com/api/splash?limit=2&page=1

要通過 API 獲取自訂啟動頁面,您可以使用此端點。您還可以篩選數據(有關更多資訊,請參閱表格)。

ParámetroDescripción
限制 (選擇)每頁數據結果
(選擇)當前頁面請求
curl --location --request GET 'https://urlkai.com/api/splash?limit=2&page=1' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/splash?limit=2&page=1”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “GET”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': 'GET', @方法
    'url': 'https://urlkai.com/api/splash?limit=2&page=1',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/splash?limit=2&page=1”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/splash?limit=2&page=1”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “error”: “0”, /錯誤“: ”0“,
    “數據”: {
        “result”: 2,
        “perpage”: 2,
        “currentpage”: 1,
        “nextpage”: 1,
        “maxpage”: 1,
        “splash”: [
            {
                “id”: 1,
                “name”: “產品 1 促銷”,
                “date”: “2020-11-10 18:00:00”
            },
            {
                “id”:2、
                “name”: “產品 2 促銷”,
                “date”: “2020-11-10 18:10:00”
            }
        ]
    }
} 

圖元

列出圖元
GET https://urlkai.com/api/pixels?limit=2&page=1

要通過 API 獲取像素代碼,您可以使用此端點。您還可以篩選數據(有關更多資訊,請參閱表格)。

ParámetroDescripción
限制 (選擇)每頁數據結果
(選擇)當前頁面請求
curl --location --request GET 'https://urlkai.com/api/pixels?limit=2&page=1' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/pixels?limit=2&page=1”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “GET”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': 'GET', @方法
    'url': 'https://urlkai.com/api/pixels?limit=2&page=1',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/pixels?limit=2&page=1”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/pixels?limit=2&page=1”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “error”: “0”, /錯誤“: ”0“,
    “數據”: {
        “result”: 2,
        “perpage”: 2,
        “currentpage”: 1,
        “nextpage”: 1,
        “maxpage”: 1,
        “像素”: [
            {
                “id”: 1,
                “type”: “gtmpixel”, /
                “name”: “GTM 圖元”,
                “標籤”: “GA-123456789”, /標籤“: ”GA-123456789“,
                “date”: “2020-11-10 18:00:00”
            },
            {
                “id”:2、
                “type”: “twitterpixel”, /
                “name”: “Twitter 圖元”,
                “tag”: “1234567”, @標籤
                “date”: “2020-11-10 18:10:00”
            }
        ]
    }
} 
創建 Pixel 像素代碼
POST https://urlkai.com/api/pixel/add

可以使用此端點創建圖元。您需要發送像素類型和標籤。

ParámetroDescripción
類型 (必需) GTMepL |Gapixel 像素 |FB像素 |AdWords 像素 |領英圖元 |推特圖元 |廣告圖元 |QuoraPixel 像素代碼 |Pinterest 公司 |必應 |Snapchat 的 |Reddit |抖音
名字 (必填)圖元的自定義名稱
標記 (必填)像素的標籤
curl --location --request POST 'https://urlkai.com/api/pixel/add' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \
--data-raw '{
    “type”: “gtmpixel”, /
    “name”: “我的 GTM”,
    “tag”: “GTM-ABCDE”
}' 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/pixel/add”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “POST”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    “type”: “gtmpixel”, /
	    “name”: “我的 GTM”,
	    “tag”: “GTM-ABCDE”
	}',
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '發佈',
    'url': 'https://urlkai.com/api/pixel/add' ,
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    正文:JSON.stringify({
    “type”: “gtmpixel”, /
    “name”: “我的 GTM”,
    “tag”: “GTM-ABCDE”
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/pixel/add”
有效載荷 = {
    “type”: “gtmpixel”, /
    “name”: “我的 GTM”,
    “tag”: “GTM-ABCDE”
}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/pixel/add”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{
    “type”: “gtmpixel”, /
    “name”: “我的 GTM”,
    “tag”: “GTM-ABCDE”
}“, System.Text.Encoding.UTF8, ”應用程式/json“);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “id”:1
} 
Actualizar píxel
PUT https://urlkai.com/api/pixel/:id/update

要更新 Pixel 像素代碼,您需要通過 PUT 請求以 JSON 格式發送有效數據。數據必須作為請求的原始正文發送,如下所示。下面的示例顯示了您可以發送的所有參數,但您不需要發送所有參數(有關更多資訊,請參閱表格)。

ParámetroDescripción
名字 (選擇)圖元的自定義名稱
標記 (必填)像素的標籤
curl --location --request PUT 'https://urlkai.com/api/pixel/:id/update' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \
--data-raw '{
    “name”: “我的 GTM”,
    “tag”: “GTM-ABCDE”
}' 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/pixel/:id/update”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “PUT”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    CURLOPT_POSTFIELDS =>
        '{
	    “name”: “我的 GTM”,
	    “tag”: “GTM-ABCDE”
	}',
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '放',
    'url': 'https://urlkai.com/api/pixel/:id/update',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    正文:JSON.stringify({
    “name”: “我的 GTM”,
    “tag”: “GTM-ABCDE”
}),
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/pixel/:id/update”
有效載荷 = {
    “name”: “我的 GTM”,
    “tag”: “GTM-ABCDE”
}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
response = requests.request(“PUT”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, “https://urlkai.com/api/pixel/:id/update”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{
    “name”: “我的 GTM”,
    “tag”: “GTM-ABCDE”
}“, System.Text.Encoding.UTF8, ”應用程式/json“);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “message”: “Pixel 已成功更新。”
} 
刪除圖元
DELETE https://urlkai.com/api/pixel/:id/delete

要刪除圖元,您需要發送 DELETE 請求。

curl --location --request 刪除 'https://urlkai.com/api/pixel/:id/delete' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/pixel/:id/delete”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “刪除”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': '刪除',
    'url': 'https://urlkai.com/api/pixel/:id/delete',
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/pixel/:id/delete”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = requests.request(“DELETE”, url, headers=headers, json=payload)
print(response.text) 的 
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, “https://urlkai.com/api/pixel/:id/delete”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “錯誤”: 0,
    “message”: “已成功刪除Pixel。”
} 

Superposiciones de CTA

列出 CTA 疊加
GET https://urlkai.com/api/overlay?limit=2&page=1

要通過 API 獲取 CTA 疊加,您可以使用此端點。您還可以篩選數據(有關更多資訊,請參閱表格)。

ParámetroDescripción
限制 (選擇)每頁數據結果
(選擇)當前頁面請求
curl --location --request GET 'https://urlkai.com/api/overlay?limit=2&page=1' \
--header '授權:持有者 YOURAPIKEY' \
--header '內容類型: application/json' \ 
$curl = curl_init();

curl_setopt_array($curl, 陣列(
    CURLOPT_URL => “https://urlkai.com/api/overlay?limit=2&page=1”,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_MAXREDIRS => 2,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_CUSTOMREQUEST => “GET”,
    CURLOPT_HTTPHEADER => [
        “授權:Bearer YOURAPIKEY”,
        “內容類型:application/json”,
    ],
    
));

$response = curl_exec($curl);

curl_close($curl);
回聲$response; 
var 請求 = require('request');
var 選項 = {
    'method': 'GET', @方法
    'url': 'https://urlkai.com/api/overlay?limit=2&page=1' ,
    '標頭': {
        '授權': 'Bearer YOURAPIKEY',
        '內容類型': 'application/json'
    },
    
};
request(options, function (error, response) {
    if (error) throw new Error(error);
    console.log(response.body);
}); 
匯入請求
url = “https://urlkai.com/api/overlay?limit=2&page=1”
有效載荷 = {}
標頭 = {
    '授權': 'Bearer YOURAPIKEY',
    '內容類型': 'application/json'
}
回應 = 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/overlay?limit=2&page=1”);
請求。Headers.Add(“授權”, “持有者 YOURAPIKEY”);
var content = new StringContent(“{}”, System.Text.Encoding.UTF8, “application/json”);
請求。內容 = 內容;
var 回應 = await 用戶端。SendAsync(請求);
回應。EnsureSuccessStatusCode();
Console.WriteLine(await 回應。Content.ReadAsStringAsync()); 
Respuesta del servidor
{
    “error”: “0”, /錯誤“: ”0“,
    “數據”: {
        “result”: 2,
        “perpage”: 2,
        “currentpage”: 1,
        “nextpage”: 1,
        “maxpage”: 1,
        “CTA”:[
            {
                “id”: 1,
                “type”: “消息”,
                “name”: “產品 1 促銷”,
                “date”: “2020-11-10 18:00:00”
            },
            {
                “id”:2、
                “type”: “聯繫人”,
                “name”: “聯繫頁面”,
                “date”: “2020-11-10 18:10:00”
            }
        ]
    }
}