Référence API pour les développeurs

启动器

Une clé API est requise pour que les demandes soient traitées par le système.Une fois qu'un utilisateur s'inscrit, une clé API est automatiquement générée pour cet utilisateur.La clé API doit être envoyée avec chaque requête (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, il y aura une erreur.Assurez-vous de garder votre clé API secrète pour éviter les abus.

身份验证

Pour vous authentifier auprès du système API, vous devez envoyer votre clé API en tant que jeton d'autorisation avec chaque demande.Vous pouvez voir un exemple de code ci-dessous.

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()); 
Limite de débit

Notre API dispose d'un limiteur de débit pour se protéger contre les pics de demandes afin de maximiser sa stabilité.Notre limiteur de débit est actuellement limité à 30 requêtes par 1 minute.请注意,费率可能会根据订阅的计划而变化。

Plusieurs en-têtes seront envoyés avec la réponse et ceux-ci peuvent être examinés pour déterminer diverses informations sur la demande.

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 29
X-RateLimit-Reset: TIMESTAMP
Gestion des réponses

Toutes les réponses de l'API sont renvoyées au format JSON par défaut.Pour convertir cela en données utilisables, la fonction appropriée devra être utilisée en fonction de la langue.En PHP, la fonction json_decode() peut être utilisée pour convertir les données en objet (par défaut) ou en tableau (définissez le deuxième paramètre sur true).Il est très important de vérifier la clé d'erreur car elle indique s'il y a eu une erreur ou non.Vous pouvez également vérifier le code d'en-tête.

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

坎帕涅

列出营销活动
GET https://urlkai.com/api/campaigns?limit=2&page=1

要通过 API 获取您的促销活动,您可以使用此终端节点。您还可以筛选数据(有关更多信息,请参阅表格)。

Paramètre La 描述
限制 (可选)每页数据结果
(可选)当前页面请求
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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “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”
            }
        ]
    }
} 
Créer une campagne
POST https://urlkai.com/api/campaign/add

可以使用此终端节点添加活动。

Paramètre La 描述
名字 (可选)活动名称
鼻涕虫 (可选)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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “message”: “已成功将链接添加到营销活动。”
} 
Mettre à jour la campagne
PUT https://urlkai.com/api/campaign/:id/update

要更新活动,您需要通过 PUT 请求以 JSON 格式发送有效数据。数据必须作为请求的原始正文发送,如下所示。下面的示例显示了您可以发送的所有参数,但您不需要发送所有参数(有关更多信息,请参阅表格)。

Paramètre La 描述
名字 (必填)活动名称
鼻涕虫 (可选)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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “message”: “已成功删除促销活动。”
} 

卡诺

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

要通过 API 获取渠道,您可以使用此终端节点。您还可以筛选数据(有关更多信息,请参阅表格)。

Paramètre La 描述
限制 (可选)每页数据结果
(可选)当前页面请求
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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “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 获取选定渠道中的项目,您可以使用此端点。您还可以筛选数据(有关更多信息,请参阅表格)。

Paramètre La 描述
限制 (可选)每页数据结果
(可选)当前页面请求
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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “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”
            }
        ]
    }
} 
Créer une chaîne
POST https://urlkai.com/api/channel/add

可以使用此终端节点添加通道。

Paramètre La 描述
名字 (必填)频道名称
描述 (可选)频道描述
颜色 (可选)通道徽章颜色 (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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “id”: 3,
    “name”: “新频道”,
    “description”: “我的新频道”,
    “color”: “#000000”, /颜色
    “starred”: true
} 
将项目分配给渠道
POST https://urlkai.com/api/channel/:channelid/assign/:type/:itemid

通过发送包含频道 ID、商品类型(链接、生物或 qr)和商品 ID 的请求,可以将商品分配给任何渠道。

Paramètre La 描述
: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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “message”: “项目已成功添加到频道。”
} 
Mettre à jour la chaîne
PUT https://urlkai.com/api/channel/:id/update

要更新通道,您需要通过 PUT 请求以 JSON 格式发送有效数据。数据必须作为请求的原始正文发送,如下所示。下面的示例显示了您可以发送的所有参数,但您不需要发送所有参数(有关更多信息,请参阅表格)。

Paramètre La 描述
名字 (可选)频道名称
描述 (可选)频道描述
颜色 (可选)通道徽章颜色 (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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “message”: 频道已成功删除。
} 

代码 QR

列出二维码
GET https://urlkai.com/api/qr?limit=2&page=1

Pour obtenir vos codes QR via l'API, vous pouvez utiliser ce point de terminaison.Vous pouvez également filtrer les données (voir le tableau pour plus d'informations).

Paramètre La 描述
限制 (可选)每页数据结果
(可选)当前页面请求
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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “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”
            }
        ]
    }
} 
Obtenez un seul code QR
GET https://urlkai.com/api/qr/:id

Pour obtenir les détails d'un seul code QR via l'API, vous pouvez utiliser ce point de terminaison.

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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 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
        }
    }
} 
Créer un code QR
POST https://urlkai.com/api/qr/add

要创建 QR 码,您需要通过 POST 请求以 JSON 格式发送有效数据。数据必须作为请求的原始正文发送,如下所示。下面的示例显示了您可以发送的所有参数,但您不需要发送所有参数(有关更多信息,请参阅表格)。

Paramètre La 描述
类型 (必填) 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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “id”: 3,
    “link”: “https:\/\/urlkai.com\/qr\/a58f79”
} 
更新二维码
PUT https://urlkai.com/api/qr/:id/update

Pour mettre à jour un QR Code, vous devez envoyer une donnée valide au format JSON via une requête PUT.Les données doivent être envoyées en tant que corps brut de votre demande, comme indiqué ci-dessous.L'exemple ci-dessous montre tous les paramètres que vous pouvez envoyer mais vous n'êtes pas obligé de tous les envoyer (voir le tableau pour plus d'informations).

Paramètre La 描述
数据 (必填)要嵌入二维码中的数据。数据可以是字符串或数组,具体取决于类型
背景 (可选)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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “message”: “二维码已成功更新。”
} 
Supprimer un code QR
DELETE https://urlkai.com/api/qr/:id/delete

Pour supprimer un code QR, vous devez envoyer une demande DELETE.

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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “message”: “已成功删除 QR 码。”
} 

Compte

Obtenir un compte
GET https://urlkai.com/api/account

Pour obtenir des informations sur le compte, vous pouvez envoyer une demande à ce point de terminaison et il renverra des données sur le compte.

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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 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”
    }
} 
Compte mis à jour
PUT https://urlkai.com/api/account/update

Pour mettre à jour les informations sur le compte, vous pouvez envoyer une demande à ce point de terminaison et il mettra à jour les données sur le compte.

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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “message”: “帐户已成功更新。”
} 

Domaines de marque

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

要通过 API 获取您的品牌域,您可以使用此终端节点。您还可以筛选数据(有关更多信息,请参阅表格)。

Paramètre La 描述
限制 (可选)每页数据结果
(可选)当前页面请求
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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “error”: “0”, /错误“: ”0“,
    “数据”: {
        “result”: 2,
        “perpage”: 2,
        “currentpage”: 1,
        “nextpage”: 1,
        “maxpage”: 1,
        “domains”: [
            {
                “id”: 1,
                “domain”: “https:\/\/domain1.com”, /// 域
                “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

可以使用此终端节点添加域。请确保域正确指向我们的服务器。

Paramètre La 描述
(必填)品牌域,包括 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”, /// 域
    “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”, /// 域
	    “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”, /// 域
    “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”, /// 域
    “redirectroot”: “https:\/\/rootdomain.com”, /
    “redirect404”: “https:\/\/rootdomain.com\/404”
}“, System.Text.Encoding.UTF8, ”应用程序/json“);
请求。内容 = 内容;
var 响应 = await 客户端。SendAsync(请求);
响应。EnsureSuccessStatusCode();
Console.WriteLine(await 响应。Content.ReadAsStringAsync()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “id”:1
} 
Mettre à jour le domaine
PUT https://urlkai.com/api/domain/:id/update

要更新品牌域,您需要通过 PUT 请求以 JSON 格式发送有效数据。数据必须作为请求的原始正文发送,如下所示。下面的示例显示了您可以发送的所有参数,但您不需要发送所有参数(有关更多信息,请参阅表格)。

Paramètre La 描述
重定向根 (可选)当有人访问您的域时进行根重定向
重定向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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “message”: “已成功删除域。”
} 

文件

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

获取您的所有文件。您还可以按名称搜索。

Paramètre La 描述
名字 (可选)按名称搜索文件
限制 (可选)每页数据结果
(可选)当前页面请求
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());
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    "error": 0,
    "result": 3,
    "perpage": 15,
    "currentpage": 1,
    "nextpage": null,
    "maxpage": 1,
    "list": [
        {
            "id": 1,
            "name": "My Photo",
            "downloads": 10,
            "shorturl": "https:\/\/urlkai.com\/PYlVT",
            "date": "2022-08-09 17:00:00"
        },
        {
            "id": 2,
            "name": "My Documents",
            "downloads": 15,
            "shorturl": "https:\/\/urlkai.com\/qBYtn",
            "date": "2022-08-10 17:01:00"
        },
        {
            "id": 3,
            "name": "My Files",
            "downloads": 5,
            "shorturl": "https:\/\/urlkai.com\/gPWkO",
            "date": "2022-08-11 19:01:00"
        }
    ]
}
上传文件
POST https://urlkai.com/api/files/upload/:filename?name=My+File

通过将二进制数据作为 post 正文发送来上传文件。您需要发送包含 extensions 而不是 url 中的 :filename 的文件名(例如 brandkit.zip)。您可以通过发送以下参数来设置选项。

Paramètre La 描述
名字 (可选)文件名
习惯 (可选)自定义别名而不是随机别名。
(可选)自定义域
密码 (可选)密码保护
满期 (可选)下载示例的过期时间 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());
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    "error": 0,
    "id": 1,
    "shorturl": "https:\/\/urlkai.com\/KiiyJ"
}

留置权


像素

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

要通过 API 获取像素代码,您可以使用此端点。您还可以筛选数据(有关更多信息,请参阅表格)。

Paramètre La 描述
限制 (可选)每页数据结果
(可选)当前页面请求
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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “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

可以使用此端点创建像素。您需要发送像素类型和标签。

Paramètre La 描述
类型 (必需) 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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “id”:1
} 
Mettre à jour le pixel
PUT https://urlkai.com/api/pixel/:id/update

要更新 Pixel 像素代码,您需要通过 PUT 请求以 JSON 格式发送有效数据。数据必须作为请求的原始正文发送,如下所示。下面的示例显示了您可以发送的所有参数,但您不需要发送所有参数(有关更多信息,请参阅表格)。

Paramètre La 描述
名字 (可选)像素的自定义名称
标记 (必填)像素的标签
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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “错误”: 0,
    “message”: “已成功删除 Pixel。”
} 

Splash personnalisé

列出自定义启动画面
GET https://urlkai.com/api/splash?limit=2&page=1

要通过 API 获取自定义启动页面,您可以使用此端点。您还可以筛选数据(有关更多信息,请参阅表格)。

Paramètre La 描述
限制 (可选)每页数据结果
(可选)当前页面请求
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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “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”
            }
        ]
    }
} 

叠加 CTA

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

要通过 API 获取 CTA 叠加,您可以使用此端点。您还可以筛选数据(有关更多信息,请参阅表格)。

Paramètre La 描述
限制 (可选)每页数据结果
(可选)当前页面请求
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()); 
Une clé API est requise pour les demandes à traiter par le système.Une fois qu'un utilisateur s'enregistre, une clé API est générée automatiquement pour cet utilisateur.La clé API doit être envoyée avec chaque requête via le paramètre clé (voir l'exemple complet ci-dessous).Si la clé API n'est pas envoyée ou a expiré, une erreur se produit.Assurez-vous de garder votre clé secrète de l'API pour éviter tout abus.
{
    “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”
            }
        ]
    }
}